Giter Club home page Giter Club logo

hull-ruby's Introduction

Hull Ruby client

Installation

Add this line to your application's Gemfile:

gem 'hullio'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hullio

Usage

Configuration

Hull.configure do |c|
  c.app_id      = "your-app-id"
  c.app_secret  = "your-app-secret"
  c.org_url     = "http://ORG-NAMESPACE.hullapp.io"
end

Making API Calls

get, put, post and delete methods are directly available on Hull.

examples:

# To get the current app
Hull.get('app')

# To get the a list of comments on the current app (with pagination)
Hull.get('app/comments', limit: 10, page: 2)

# To update an existing object
Hull.put('app', { name: 'My Super App' })

with Hull entities :

Hull.get('entity', { uid: 'http://example.com' })
Hull.put('entity', { uid: 'http://example.com', name: 'My super Page' })
Hull.delete('entity', { uid: 'http://example.com' })

Compiling widgets and tempaltes with Rails' Assets Pipeline

Load handlebars_assets in your Gemfile as part of the assets group

group :assets do
  gem 'handlebars_assets'
end

Place your widgets inside the app/assets/javascripts dir.

app
├── assets
│   ├── javascripts
│   │   ├── application.js
│   │   └── hello
│   │       ├── hello.hbs
│   │       └── main.js

And require the in your application.js file :

//= require handlebars
//= require_tree .

Bring your own users

In addition to providing multiple social login options, Hull allows you to create and authenticate users that are registered within your own app.

To use this feature, you just have to add a userHash key at the initialization of hull.js :

In you view :

<script>
  Hull.init({
    appId:  "<%= Hull.app_id %>",
    orgUrl: "<%= Hull.org_url %>",
    userHash: "<%= Hull.user_hash({ id: "123", email: "[email protected]", name: "Bill Evans" })  %>"
  });
</script>

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

hull-ruby's People

Contributors

sbellity avatar

Watchers

Brett Ulrich avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.