hullio 0.3.1 → 0.3.2

data/README.md

@@ -18,11 +18,13 @@ Or install it yourself as:
 
 ### 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
+```rb
+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
+```
 
 In Rails, you can include this in an initializer.
 
@@ -30,63 +32,67 @@ In Rails, you can include this in an initializer.
 
 `get`, `put`, `post` and `delete` methods are directly available on Hull.
 
-examples: 
+examples:
 
-    # To get the current app
-    Hull.get('app')
+```rb
+# 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 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' })
+# 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' })
-
+```rb
+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' })
+```
 
 ### Making API calls as as a User
 
-From its user ID
-
-        Hull.as('51fa7afd09e50d11f1000002').get('me')
-
-From a user UID
-
-        Hull.as('twitter:hull').get('me')
-        Hull.as('external:3637').get('me')
-
+```rb
+# From its user ID
+Hull.as('51fa7afd09e50d11f1000002').get('me')
 
+# From a user UID
+Hull.as('twitter:hull').get('me')
+Hull.as('external:3637').get('me')
+```
 
 ### Getting the current User
 
-Hull.authenticate_user allows you to get the current User's ID.
+`Hull.authenticate_user` allows you to get the current User's ID.
 
 #### Rails
 
-
-        class MyController < ApplicationController
-            def current_hull_user_id
-                @current_hull_user_id ||= Hull.authenticate_user(request.env)
-            end
-            def current_hull_user
-                // You probably should cache this or record this information in a session
-                // to avoid making calls to Hull's API on each request
-                @current_hull_user ||= Hull.get(current_hull_user_id)
-            end
-        end
+```rb
+class MyController < ApplicationController
+  def current_hull_user
+    # You probably should cache this or record this information in a session
+    # to avoid making calls to Hull's API on each request
+    @current_hull_user ||= Hull.get(current_hull_user_id)
+  end
+  
+  def current_hull_user_id
+    @current_hull_user_id ||= Hull.authenticate_user(request.env)
+  end
+end
+```
 
 ### Compiling widgets and templates with Rails' Assets Pipeline
 
 Load `handlebars_assets` in your Gemfile as part of the assets group
 
-    group :assets do
-      gem 'handlebars_assets'
-    end
-
+```rb
+group :assets do
+  gem 'handlebars_assets'
+end
+```
 
 Place your widgets inside the `app/assets/javascripts` dir.
 
@@ -100,28 +106,42 @@ Place your widgets inside the `app/assets/javascripts` dir.
 
 And require the in your `application.js` file :
 
-
-    //= require handlebars
-    //= require_tree .
-
+```js
+//= 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 : 
+To use this feature, you just have to add a `userHash` key at the initialization of hull.js :
+
+In you view :
+
+```html
+<script>
+  Hull.init({
+    appId:  "<%= Hull.app_id %>",
+    orgUrl: "<%= Hull.org_url %>",
+    userHash: "<%= Hull.user_hash({ id: "123", email: "bill@hullapp.io", name: "Bill Evans" })  %>"
+  });
+</script>
+```
 
-In you view : 
+### Hooks
 
-    <script>
-      Hull.init({
-        appId:  "<%= Hull.app_id %>",
-        orgUrl: "<%= Hull.org_url %>",
-        userHash: "<%= Hull.user_hash({ id: "123", email: "bill@hullapp.io", name: "Bill Evans" })  %>"
-      });
-    </script>
+[Hooks](hull.io/docs/libraries/#hooks) allow you to be notified every time an
+object in your app is created, updated or deleted.
 
+```ruby
+require 'hull/middlewares/hook'
 
+# path option default is '/__hull-hook__'
+use Hull::Middlewares::Hook, path: '/hullook', secret: ENV['HULL_APP_SECRET'] do |event, request|
+  # Do something with event
+end
+```
 
 ## Contributing
 

data/lib/hull/request.rb

@@ -1,7 +1,9 @@
 module Hull
   # Defines HTTP request methods
   module Request
-    
+    API_PATH_REGEXP = /^\/?api\/v1\//
+    API_PATH = '/api/v1/'
+
     # Perform an HTTP DELETE request
     def delete(path, params={}, options={})
       request(:delete, api_path(path), params, options)
@@ -22,13 +24,13 @@ module Hull
       request(:put, api_path(path), params, options)
     end
 
-  private
+    private
 
-    def api_path path
-      if path =~ /^\//
-        path.to_s
+    def api_path(path)
+      if path =~ API_PATH_REGEXP
+        path.gsub(API_PATH_REGEXP, API_PATH)
       else
-        "/api/v1/#{path.to_s.gsub(/^\//, '')}"
+        API_PATH + (path[0] == '/' ? path[1..-1] : path)
       end
     end
 
@@ -47,6 +49,5 @@ module Hull
       end
       options[:raw] ? response : response.body
     end
-
   end
 end

data/lib/hull/version.rb

@@ -1,3 +1,3 @@
 module Hull
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hullio
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday