remotely 0.2.0 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ba680c908518656cda92b0f0b38f2eb73db06ce
+  data.tar.gz: b2fc47594894157857682de954a0679b3755561d
+SHA512:
+  metadata.gz: 15de8ebc5f4f41ddca9bf7004f09d3e2a595f8b0a632c1aa4bba432e38faac6e0775cbcc05e350ee2fb97e279dec93a0cfd7007fe8ad13a5f91012a4bbc2cb75
+  data.tar.gz: f6c015352eebebf77eeff181238de6590e264a286ffe9355c6e2de12a6bb65a1d04d0fd629f769f42d95cc981ddbc47e649b7970f77cb79d24281abe48844808

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 
 platforms :jruby do

data/README.md

@@ -73,6 +73,59 @@ A path can include "`:id`" anywhere in it, which is replaced by the instance's `
     m.id   # => 1
     m.legs # => Requests "/millepieds/1/legs"
 
+## Authorization
+
+Remotely is setup to allow basic auth, token auth, or custom authentication schemes. 
+
+**Basic Auth**
+
+`basic_auth` accepts 2 String params: `username` and `password`
+	
+    # 'Authorization' header => "Basic dXNlcjpwYXNzd29yZA=="
+    
+    Remotely.configure do
+      app :legsapp do
+        url "http://somanylegs.com/api/v1"
+        basic_auth "username", "password"
+      end
+    end
+    
+**Token Auth**
+
+`token_auth` accepts a String param for the `token`, and an optional Hash of token options
+	
+    # 'Authorization' header => "Token token=\"abcdef\", foo=\"bar\""
+    
+    Remotely.configure do
+      app :legsapp do
+        url "http://somanylegs.com/api/v1"
+        token_auth "abcdef", {:foo => 'bar'}
+      end
+    end
+    
+**Custom Authorization**
+
+`authorization` accepts a String param for the `type`, and either a String or Hash `token`. A String value is taken literally, and a Hash is encoded into comma separated key/value pairs.
+	
+    # 'Authorization' header => "Bearer mF_9.B5f-4.1JqM"
+    
+    Remotely.configure do
+      app :legsapp do
+        url "http://somanylegs.com/api/v1"
+        authorization 'Bearer', 'mF_9.B5f-4.1JqM'
+      end
+    end
+ 
+
+    # 'Authorization' header => "OAuth token=\"abcdef\", foo=\"bar\""
+    
+    Remotely.configure do
+      app :legsapp do
+        url "http://somanylegs.com/api/v1"
+        authorization 'OAuth', {:token => 'abcdef', :foo => 'bar'}
+      end
+    end
+
 ## Fetched Objects
 
 Remote associations are Remotely::Model objects. Whatever data the API returns, becomes the attributes of the Model.

data/lib/remotely/application.rb

@@ -25,6 +25,28 @@ module Remotely
       return @basic_auth unless user && password
       @basic_auth = [user, password]
     end
+    
+    # Set or get the Authorization header.
+    #  - As seen here: https://github.com/lostisland/faraday/blob/master/lib/faraday/connection.rb#L204
+    # 
+    # @param [String] token   - The String token.
+    # @param [Hash]   options - Optional Hash of extra token options.
+    #
+    def token_auth(token=nil, options={})
+      return @token_auth unless token
+      @token_auth = [token, options]
+    end
+    
+    # Set or get a custom Authorization header.
+    #  - As seen here: https://github.com/lostisland/faraday/blob/master/lib/faraday/connection.rb#L227
+    # 
+    # @param [String]       type    - The String authorization type.
+    # @param [String|Hash]  token   - The String or Hash token.  A String value is taken literally, and a Hash is encoded into comma separated key/value pairs.
+    #
+    def authorization(type=nil, token=nil)
+      return @authorization unless type && token
+      @authorization = [type, token]
+    end
 
     # Connection to the application (with BasicAuth if it was set).
     #
@@ -35,8 +57,10 @@ module Remotely
         b.request :url_encoded
         b.adapter :net_http
       end
-
-      @connection.basic_auth(*@basic_auth) if @basic_auth
+      
+      @connection.basic_auth(*@basic_auth)        if @basic_auth
+      @connection.token_auth(*@token_auth)        if @token_auth
+      @connection.authorization(*@authorization)  if @authorization
       @connection
     end
 

data/lib/remotely/http_methods.rb

@@ -147,7 +147,7 @@ module Remotely
     end
 
     def raise_if_html(response)
-      if response.body =~ %r(<html>)
+      if response.body =~ %r(<html.?*>)i
         raise Remotely::NonJsonResponseError.new(response.body)
       end
       response

data/lib/remotely/version.rb

@@ -1,3 +1,3 @@
 module Remotely
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/remotely/application_spec.rb

@@ -15,6 +15,21 @@ describe Remotely::Application do
     app = Remotely::Application.new(:name) { basic_auth "user", "pass" }
     app.basic_auth.should == ["user", "pass"]
   end
+  
+  it "sets token auth credentials" do
+    app = Remotely::Application.new(:name) { token_auth "token", {:foo => :bar} }
+    app.token_auth.should == ["token", {:foo => :bar}]
+  end
+  
+  it "sets custom authorization credentials as a string" do
+    app = Remotely::Application.new(:name) { authorization "OAuth", "token=foo" }
+    app.authorization.should == ["OAuth", "token=foo"]
+  end
+  
+  it "sets custom authorization credentials as a hash" do
+    app = Remotely::Application.new(:name) { authorization "OAuth", {:token => :foo} }
+    app.authorization.should == ["OAuth", {:token => :foo}]
+  end
 
   it "has a connection to the app" do
     app = Remotely::Application.new(:name) { url "http://example.com" }
@@ -28,4 +43,20 @@ describe Remotely::Application do
     end
     app.connection.headers["authorization"].should_not be_nil
   end
+  
+  it "has a connection with token auth to the app" do
+    app = Remotely::Application.new(:name) do
+      url        "http://example.com"
+      token_auth "token", {:foo => :bar}
+    end
+    app.connection.headers["authorization"].should_not be_nil
+  end
+  
+  it "has a connection with custom authorization to the app" do
+    app = Remotely::Application.new(:name) do
+      url           "http://example.com"
+      authorization "OAuth", {:token => :foo}
+    end
+    app.connection.headers["authorization"].should_not be_nil
+  end
 end

data/spec/remotely/http_methods_spec.rb

@@ -4,12 +4,12 @@ describe Remotely::HTTPMethods do
   include Remotely::HTTPMethods
 
   it "raises NonJsonResponseError when HTML is returned on GET" do
-    stub_request(:get, %r(/things)).to_return(body: "<html><head><title></title></head></html>")
+    stub_request(:get, %r(/things)).to_return(body: "<html lang='en'><head><title></title></head></html>")
     expect { get("/things") }.to raise_error(Remotely::NonJsonResponseError)
   end
 
   it "raises NonJsonResponseError when HTML is returned on POST" do
-    stub_request(:post, %r(/things)).to_return(body: "<html><head><title></title></head></html>")
+    stub_request(:post, %r(/things)).to_return(body: "<HTML><HEAD><TITLE></TITLE></HEAD></HTML>")
     expect { post("/things") }.to raise_error(Remotely::NonJsonResponseError)
   end
 

data/spec/remotely/model_spec.rb

@@ -279,6 +279,81 @@ describe Remotely::Model do
       a_request(:get, "#{app}/adventures/1").with(headers: {})
     end
   end
+  
+  context "token auth" do
+    before do
+      Remotely.configure do
+        app :adventure_app do
+          url "http://localhost:3000"
+          token_auth "token", {:foo => :bar}
+        end
+      end
+    end
+
+    after do
+      Remotely.reset!
+    end
+
+    it "sends Authorization headers when token auth is configured" do
+      Adventure.find(1)
+      a_request(:get, "#{app}/adventures/1").with(headers: {'Authorization' => "Token token=token foo=bar"})
+    end
+
+    it "doesn't send Authorization headers when token auth is not configured" do
+      Adventure.find(1)
+      a_request(:get, "#{app}/adventures/1").with(headers: {})
+    end
+  end
+  
+  context "custom authorization as a string" do
+    before do
+      Remotely.configure do
+        app :adventure_app do
+          url "http://localhost:3000"
+          authorization "OAuth", "token=foo"
+        end
+      end
+    end
+
+    after do
+      Remotely.reset!
+    end
+
+    it "sends Authorization headers when custom authorization is configured" do
+      Adventure.find(1)
+      a_request(:get, "#{app}/adventures/1").with(headers: {'Authorization' => "OAuth token=foo"})
+    end
+
+    it "doesn't send Authorization headers when custom authorization is not configured" do
+      Adventure.find(1)
+      a_request(:get, "#{app}/adventures/1").with(headers: {})
+    end
+  end
+  
+  context "custom authorization as a hash" do
+    before do
+      Remotely.configure do
+        app :adventure_app do
+          url "http://localhost:3000"
+          authorization "OAuth", {:token => :foo}
+        end
+      end
+    end
+
+    after do
+      Remotely.reset!
+    end
+
+    it "sends Authorization headers when custom authorization is configured" do
+      Adventure.find(1)
+      a_request(:get, "#{app}/adventures/1").with(headers: {'Authorization' => "OAuth token=foo"})
+    end
+
+    it "doesn't send Authorization headers when custom authorization is not configured" do
+      Adventure.find(1)
+      a_request(:get, "#{app}/adventures/1").with(headers: {})
+    end
+  end
 
   it "sets the app it belongs to" do
     Adventure.app.name.should == :adventure_app

data/spec/remotely_spec.rb

@@ -25,4 +25,19 @@ describe Remotely do
     Remotely.configure { app(:appname) { basic_auth "user", "pass" }}
     Remotely.apps[:appname].basic_auth.should == ["user", "pass"]
   end
+  
+  it "saves the token auth credentials" do
+    Remotely.configure { app(:appname) { token_auth "token", {:foo => :bar} }}
+    Remotely.apps[:appname].token_auth.should == ["token", {:foo => :bar}]
+  end
+  
+  it "saves the authorization credentials as a string" do
+    Remotely.configure { app(:appname) { authorization "OAuth", "token=foo" }}
+    Remotely.apps[:appname].authorization.should == [ "OAuth", "token=foo" ]
+  end
+  
+  it "saves the authorization credentials as a hash" do
+    Remotely.configure { app(:appname) { authorization "OAuth", {:token => :foo} }}
+    Remotely.apps[:appname].authorization.should == [ "OAuth", {:token => :foo}]
+  end
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: remotely
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - Matte Noble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-01 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,81 +41,71 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Remote API based model associations.
@@ -158,27 +143,26 @@ files:
 - spec/support/webmock.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Remote API based model associations.
 test_files:
 - spec/remotely/application_spec.rb
@@ -191,3 +175,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/test_classes.rb
 - spec/support/webmock.rb
+has_rdoc: