hullio 0.3.3 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5134dd78b1ec380b06cb7b2eded06f3d25e11a77
+  data.tar.gz: bfe1fdc35d805dab9189fb0bb05d034ba5c21a5d
+SHA512:
+  metadata.gz: 40811b930da961adaccc6685d7578b9ab59c89bed446d837c55b809b8aa95ecc08c8b21026947dc1eed0cbb82a4ae12a511df549eff3ab9cd875c6c542cf3c9e
+  data.tar.gz: b5f2bf57375f6bd160ca0e9882cb40af60037745c606f6327199164c58f8fdbef86bc5801ce5dd8ee0e5a4fee1ca6512da4063e36ff567352f24594674721564

data/.editorconfig

@@ -0,0 +1,13 @@
+; EditorConfig helps developers define and maintain consistent
+; coding styles between different editors and IDEs
+; editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/CHANGELOG

@@ -0,0 +1,6 @@
+# 0.4.0
+
+* Add support for JWTs
+* Add helpers for Entities `Hull::Entity.encode` and `Hull::Entity.decode`
+
+

data/Gemfile

@@ -1,22 +1,4 @@
 source 'https://rubygems.org'
 
-gem 'faraday', '0.8.9'
-
-group :development, :test do
-  gem 'rake'
-  gem 'guard', '~> 2.6'
-  gem 'guard-rspec', '~> 4', require: false
-  gem 'typhoeus' unless defined? JRUBY_VERSION
-  gem 'pry-debugger'
-end
-
-group :test do
-  gem 'rspec', '~> 3.0'
-  gem 'webmock'
-end
-
-gem 'jruby-openssl' if defined? JRUBY_VERSION
-
+# Specify your gem's dependencies in hullio.gemspec
 gemspec
-
-

data/README.md

@@ -18,7 +18,7 @@ Or install it yourself as:
 
 ### Configuration
 
-```rb
+```ruby
 Hull.configure do |c|
   c.app_id = "your-app-id"
   c.app_secret = "your-app-secret"
@@ -35,25 +35,32 @@ In Rails, you can include this in an initializer.
 examples:
 
 ```rb
-# To get the current app
+# Get the current app
 Hull.get('app')
 
-# To get the a list of comments on the current app (with pagination)
+# 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
+# Update an existing object
 Hull.put('app', { name: 'My Super App' })
 ```
 
 with Hull entities :
 
 ```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' })
+entityId = Hull::Entity.encode('http://example.com')
+#=>"~aHR0cDovL2V4YW1wbGUuY29t"
+
+Hull.get(entityId)
+Hull.put(entityId)
+Hull.delete(entityId)
 
 # Get comments on the Entity identified by 'http://example.com' 
-Hull.get('entity/comments', { uid: 'http://example.com' })
+Hull.get(entityId+'/comments')
+
+# Decoding an encoded entity:
+Hull::Entity.decode(entityId)
+#=>'http://example.com'
 ```
 
 ### Making API calls as as a User
@@ -62,72 +69,57 @@ Hull.get('entity/comments', { uid: 'http://example.com' })
 # From its user ID
 Hull.as('51fa7afd09e50d11f1000002').get('me')
 
-# From a user UID
+# Find a User based on his identity from an external service:
+
+# Find user from his Twitter handle:
 Hull.as('twitter:hull').get('me')
+
+# Find user from his Faceboo ID
+Hull.as('facebook:fb_uid').get('me')
+
+# Find user from his ID in your app (BYOU)
 Hull.as('external:3637').get('me')
+
+# From a User in your database, with lazy creation (Checkout [Bring your own Users Documentation](http://hull.io/docs/users/byou))
+userHash = {external_id:'1234', name:'Romain', email:'user@host.com'}
+Hull.as(userHash).get('me')
 ```
 
 ### Getting the current User
 
-`Hull.authenticate_user` allows you to get the current User's ID.
+`Hull.authenticate_user` allows you to retrieve the current User's ID.
 
 #### Rails
 
 ```rb
 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
   
-  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
-
-```rb
-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 :
-
-```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 :
+Using JWT, you can use Hull with Users from your system.
+To use this feature, you just have to add a `accessToken` key at the initialization of hull.js. Read more at http://hull.io/docs/users/byou
 
-In you view :
+In your 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" })  %>"
+    accessToken: "<%= Hull.user_token({external_id: "123", email: "bill@hullapp.io", name: "Bill Evans" })  %>"
   });
 </script>
 ```

data/Rakefile

@@ -1,9 +1,2 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :test => :spec
-
-task :default => [:spec]
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/hullio.gemspec

@@ -14,13 +14,18 @@ Gem::Specification.new do |gem|
   gem.name          = "hullio"
   gem.require_paths = ["lib"]
   gem.version       = Hull::VERSION
+  gem.licenses      = ['MIT']
 
   # Dependencies
-  gem.add_dependency 'faraday', '>= 0.8'
-  gem.add_dependency 'faraday_middleware'
-  gem.add_dependency 'multi_json'
-  gem.add_dependency 'mime-types'
+  gem.add_dependency 'faraday', ['>= 0.7', '< 0.10']
+  gem.add_dependency 'faraday_middleware', ['>= 0.7', '< 0.10']
+  gem.add_dependency 'multi_json', '~> 1.0'
+  gem.add_dependency 'mime-types', '~> 2.0'
+  gem.add_dependency 'jwt', '~> 1.0'
+  gem.add_dependency 'addressable', '~> 2.3'
+  gem.add_dependency 'postrank-uri', '~> 1.0'
 
   # Development Dependencies
   gem.add_development_dependency 'activesupport', ['>= 2.3.9', '< 4']
+
 end

data/lib/hull.rb

@@ -1,6 +1,7 @@
 require 'hull/core_ext/hash'
 require 'hull/client'
 require 'hull/config'
+require 'hull/entity'
 
 module Hull
   extend Config
@@ -12,8 +13,12 @@ module Hull
       Hull::Client.new(options)
     end
 
-    def as(user_id)
-      Hull::Client.new({ user_id: user_id })
+    def as(user)
+      if user.is_a?(String)
+        Hull::Client.new({ user_id: user })
+      else
+        Hull::Client.new({ access_token: self.user_token(user) })
+      end
     end
 
     # Delegate to Hull::Client

data/lib/hull/client.rb

@@ -3,6 +3,7 @@ require 'hull/connection'
 require 'hull/request'
 require 'base64'
 require 'openssl'
+require 'jwt'
 
 module Hull
   class Client
@@ -25,12 +26,13 @@ module Hull
 
     def credentials
       {
-        :app_id      => @app_id,
-        :app_secret  => @app_secret,
-        :user_id     => @user_id,
+        :app_id       => @app_id,
+        :app_secret   => @app_secret,
+        :user_id      => @user_id,
+        :access_token => @access_token
       }
     end
-    
+
     def app
       return unless app_id
       @app ||= get("/app", :app_id => app_id)
@@ -51,7 +53,7 @@ module Hull
     end
 
     def authenticate_user env
-      require 'rack/request'  
+      require 'rack/request'
       request = Rack::Request.new(env)
       cookie  = request.cookies["hull_#{self.app_id}"]
       user_auth = read_cookie(cookie)
@@ -65,6 +67,19 @@ module Hull
       sig = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), app_secret, [message, timestamp].join(" "))
       [message, sig, timestamp].join(" ")
     end
-    
+
+    def user_token user, claims={}
+      claims = claims.inject({}) { |c,(k,v)| c.merge(k.to_sym => v) }
+      if user.is_a?(String)
+        claims[:sub] = user
+      else
+        claims[:'io.hull.user'] = user
+      end
+      claims = claims.merge({ iat: Time.now.to_i, iss: app_id })
+      claims[:nbf] = claims[:nbf].to_i if claims[:nbf]
+      claims[:exp] = claims[:exp].to_i if claims[:exp]
+      JWT.encode(claims, app_secret)
+    end
+
   end
-end
+end

data/lib/hull/config.rb

@@ -15,7 +15,7 @@ module Hull
     DEFAULT_APP_SECRET = ENV['HULL_APP_SECRET']
     DEFAULT_APP_ID =     ENV['HULL_APP_ID']
 
-  
+
     # The ORG_URL that will be used to connect if none is set
     #
     DEFAULT_ORG_URL = ENV['HULL_ORG_URL']
@@ -24,7 +24,7 @@ module Hull
     DEFAULT_CACHE_STORE = nil
 
     DEFAULT_PROXY = nil
-    
+
     # The value sent in the 'User-Agent' header if none is set
     DEFAULT_USER_AGENT = "Hull Ruby Gem #{Hull::VERSION}"
 
@@ -44,7 +44,8 @@ module Hull
       :cache_store,
       :logger,
       :current_user,
-      :user_id, 
+      :user_id,
+      :access_token,
       :authenticate_users,
       :user_attributes,
       :js_url

data/lib/hull/entity.rb

@@ -0,0 +1,43 @@
+require 'addressable/uri'
+require 'postrank-uri'
+
+class Hull::Entity
+
+  class InvalidUID < StandardError; end
+
+  def self.valid_uri?(uri)
+    Addressable::URI.parse(uri).domain
+  rescue Addressable::URI::InvalidURIError
+    false
+  end
+
+  def self.decode uid
+    raise(InvalidUID, uid) unless uid.is_a?(String)
+    if uid =~ /^~[a-z0-9_\-\+\/\=]+$/i && (uid.length - 1) % 4 == 0
+      uid = uid.gsub(/^~/, '')
+      begin
+        if uid =~ /\/\+/
+          uid = Base64.decode64(uid)
+        else
+          uid = Base64.urlsafe_decode64(uid)
+        end
+      rescue => err
+        raise InvalidUID, err.message
+      end
+    end
+
+    if valid_uri?(uid)
+      uid = PostRank::URI.clean(uid)
+    end
+
+    begin
+      uid.encode(Encoding::UTF_8)
+    rescue => err
+      raise InvalidUID, err.message
+    end
+  end
+
+  def self.encode uid
+    "~#{Base64.urlsafe_encode64(uid)}"
+  end
+end

data/lib/hull/request/auth.rb

@@ -5,9 +5,13 @@ module Hull
     class Auth  < Faraday::Middleware
 
       def call(env)
-        env[:request_headers]["Hull-Access-Token"] = @credentials[:app_secret]
         env[:request_headers]["Hull-App-Id"] = @credentials[:app_id]
-        env[:request_headers]["Hull-User-Id"] = @credentials[:user_id] if @credentials[:user_id]
+        if !@credentials[:access_token].nil?
+          env[:request_headers]["Hull-Access-Token"] = @credentials[:access_token]
+        else
+          env[:request_headers]["Hull-Access-Token"] = @credentials[:app_secret]
+          env[:request_headers]["Hull-User-Id"] = @credentials[:user_id] if @credentials[:user_id]
+        end
         @app.call(env)
       end
 
@@ -17,4 +21,4 @@ module Hull
 
     end
   end
-end
+end

data/lib/hull/version.rb

@@ -1,3 +1,3 @@
 module Hull
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hullio
 version: !ruby/object:Gem::Version
-  version: 0.3.3
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Stephane Bellity
@@ -10,94 +9,138 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
-    none: false
-  prerelease: false
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
-    none: false
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-  prerelease: false
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-  prerelease: false
+        version: '1.0'
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
+        version: '2.0'
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: postrank-uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.9
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-    none: false
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.9
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-    none: false
 description: Hull Ruby Client
 email:
 - stephane@hull.io
@@ -105,7 +148,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".editorconfig"
+- ".gitignore"
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
@@ -116,6 +161,7 @@ files:
 - lib/hull/config.rb
 - lib/hull/connection.rb
 - lib/hull/core_ext/hash.rb
+- lib/hull/entity.rb
 - lib/hull/middlewares/hook.rb
 - lib/hull/paywall.rb
 - lib/hull/request.rb
@@ -124,28 +170,27 @@ files:
 - lib/hull/version.rb
 - lib/hullio.rb
 homepage: http://hull.io
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Hull Ruby Client
 test_files: []
-has_rdoc: