active_rest_client 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e90aa3aab74da133bb45147624a0723812c609e
-  data.tar.gz: fe25689f084ddcaa682c7230152e2c1a49fa03db
+  metadata.gz: 323d3696fb921ff5d23de556ec82ca0ee07fadea
+  data.tar.gz: 852a377147513500e2a0d1fdc92bbdf38d30c76d
 SHA512:
-  metadata.gz: a5376c72339436353eb5e46ef657c479bda1adb14bd446e7bc731aae88ace39c6a42a64a449de3cb49f3f123c3f2b1ef85a0e214ff01c4f838bc5fd07f1e7e0c
-  data.tar.gz: dbf38d4b667137b07724da1d3fb0d365f7cb415df6b7aafd28cbcb4c1b74d5e225077a221110342de9bded154501708022883f35e35d9bf5de90340d00db1729
+  metadata.gz: 911ece68f67242d67f06e279f13398624ed35a0828dd92e2f960b8ceb9ed1663b6790f8f25899e2b9224ff7fb2182fe7faf4d68eb4b64cc7451a1075de655afb
+  data.tar.gz: f62c9f442fe875811da762bcb6b87a3a7d52ccd3cd161b8926a1397b201f0fdf0112eade77ae1b6bcd8d8fca8bb5b570b05fc5e2554a87dc155798ffc4ea0398

data/README.md

@@ -146,7 +146,7 @@ There are two types of association.  One assumes when you call a method you actu
 
 #### Association Type 1 - Loading Other Classes
 
-If the call would return a list of instances that should be considered another object, you can also specify this when mapping the method using the `:has_many` option.  It doesn't call anything on that object except for instantiate it, but it does let you have objects of a different class to the one you initially called.
+If the call would return a single instance or a list of instances that should be considered another object, you can also specify this when mapping the method using the `:has_one` or `:has_many` options respectively.  It doesn't call anything on that object except for instantiate it, but it does let you have objects of a different class to the one you initially called.
 
 ```ruby
 class Expense < ActiveRestClient::Base
@@ -155,12 +155,19 @@ class Expense < ActiveRestClient::Base
   end
 end
 
+class Address < ActiveRestClient::Base
+  def full_string
+    return "#{self.street}, #{self.city}, #{self.region}, #{self.country}"
+  end
+end
+
 class Person < ActiveRestClient::Base
-  get :find, "/people/:id", :has_many => {:expenses => Expense}
+  get :find, "/people/:id", :has_many => {:expenses => Expense}, :has_one => {:address => Address}
 end
 
 @person = Person.find(1)
 puts @person.expenses.reduce {|e| e.inc_vat}
+puts @person.address.full_string
 ```
 
 #### Association Type 2 - Lazy Loading From Other URLs
@@ -345,6 +352,8 @@ class Person < ActiveRestClient::Base
 
   before_request :replace_body
 
+  before_request :override_default_content_type
+
   private
 
   def replace_token_in_url(name, request)
@@ -360,6 +369,12 @@ class Person < ActiveRestClient::Base
       request.body = request.post_params.to_json
     end
   end
+
+  def override_default_content_type(name, request)
+    if name == :save
+      request.headers["Content-Type"] = "application/json"
+    end
+  end
 end
 ```
 
@@ -424,6 +439,8 @@ This will return an array of the named method for each object or the response fr
 
 ### Authentication
 
+#### Basic
+
 You can authenticate with Basic authentication by putting the username and password in to the `base_url` or by setting them within the specific model:
 
 ```ruby
@@ -435,6 +452,20 @@ class Person < ActiveRestClient::Base
 end
 ```
 
+#### Api-Auth
+
+Using the [Api-Auth](https://github.com/mgomes/api_auth) integration it is very easy to sign requests. Include the Api-Auth gem in your Gemfile and in then add it to your application. Then simply configure Api-Auth one time in your app and all requests will be signed from then on.
+
+```ruby
+require 'api-auth'
+
+@access_id = '123456'
+@secret_key = 'abcdef'
+ActiveRestClient::Base.api_auth_credentials(@access_id, @secret_key)
+```
+
+For more information on how to generate an access id and secret key please read the [Api-Auth](https://github.com/mgomes/api_auth) documentation.
+
 ### Body Types
 
 By default ActiveRestClient puts the body in to normal CGI parameters in K=V&K2=V2 format.  However, if you want to use JSON for your PUT/POST requests, you can use either (the other option, the default, is `:form_encoded`):
@@ -452,7 +483,7 @@ or
 ActiveRestClient::Base.request_body_type = :json
 ```
 
-This will also set the header `Content-Type` to `application/x-www-form-urlencoded` by default or `application/json` when `:json`.
+This will also set the header `Content-Type` to `application/x-www-form-urlencoded` by default or `application/json; charset=utf-8` when `:json`. You can override this using the filter `before_request`.
 
 If you have an API that is inconsistent in its body type requirements, you can also specify it on the individual method mapping:
 

data/active_rest_client.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency 'terminal-notifier-guard'
   spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency "api-auth", ">= 1.3.1"
 
   spec.add_runtime_dependency "multi_json"
   spec.add_runtime_dependency "activesupport"

data/lib/active_rest_client/base.rb

@@ -181,4 +181,5 @@ module ActiveRestClient
 
   class NoAttributeException < StandardError ; end
   class ValidationFailedException < StandardError ; end
+  class MissingOptionalLibraryError < StandardError ; end
 end

data/lib/active_rest_client/configuration.rb

@@ -6,6 +6,8 @@ module ActiveRestClient
       @@password = nil
       @@request_body_type = :form_encoded
       @lazy_load = false
+      @@api_auth_access_id = nil
+      @@api_auth_secret_key = nil
 
       def base_url(value = nil)
         if value.nil?
@@ -106,6 +108,29 @@ module ActiveRestClient
         value ? @whiny_missing = value : @whiny_missing || false
       end
 
+      def api_auth_credentials(access_id, secret_key)
+        begin
+          require 'api-auth'
+        rescue LoadError
+          raise MissingOptionalLibraryError.new("You must include the gem 'api-auth' in your Gemfile to set api-auth credentials.")
+        end
+
+        @@api_auth_access_id = access_id
+        @@api_auth_secret_key = secret_key
+      end
+
+      def using_api_auth?
+        !@@api_auth_access_id.nil? && !@@api_auth_secret_key.nil?
+      end
+
+      def api_auth_access_id
+        @@api_auth_access_id
+      end
+
+      def api_auth_secret_key
+        @@api_auth_secret_key
+      end
+
       def verbose!
         @verbose = true
       end
@@ -124,14 +149,16 @@ module ActiveRestClient
       end
 
       def _reset_configuration!
-        @base_url           = nil
-        @@base_url          = nil
-        @request_body_type  = nil
-        @@request_body_type = :form_encoded
-        @whiny_missing      = nil
-        @lazy_load          = false
-        @faraday_config     = default_faraday_config
-        @adapter            = :patron
+        @base_url             = nil
+        @@base_url            = nil
+        @request_body_type    = nil
+        @@request_body_type   = :form_encoded
+        @whiny_missing        = nil
+        @lazy_load            = false
+        @faraday_config       = default_faraday_config
+        @adapter              = :patron
+        @@api_auth_access_id  = nil
+        @@api_auth_secret_key = nil
       end
 
       private

data/lib/active_rest_client/connection.rb

@@ -38,6 +38,7 @@ module ActiveRestClient
       make_safe_request(path) do
         @session.get(path) do |req|
           req.headers = req.headers.merge(headers)
+          sign_request(req)
         end
       end
     end
@@ -47,6 +48,7 @@ module ActiveRestClient
         @session.put(path) do |req|
           req.headers = req.headers.merge(headers)
           req.body = data
+          sign_request(req)
         end
       end
     end
@@ -56,6 +58,7 @@ module ActiveRestClient
         @session.post(path) do |req|
           req.headers = req.headers.merge(headers)
           req.body = data
+          sign_request(req)
         end
       end
     end
@@ -64,6 +67,7 @@ module ActiveRestClient
       make_safe_request(path) do
         @session.delete(path) do |req|
           req.headers = req.headers.merge(headers)
+          sign_request(req)
         end
       end
     end
@@ -74,9 +78,16 @@ module ActiveRestClient
       Faraday.new({url: @base_url}, &ActiveRestClient::Base.faraday_config)
     end
 
-
     def full_url(path)
       @session.build_url(path).to_s
     end
+
+    def sign_request(request)
+      return if !ActiveRestClient::Base.using_api_auth?
+      ApiAuth.sign!(
+        request,
+        ActiveRestClient::Base.api_auth_access_id,
+        ActiveRestClient::Base.api_auth_secret_key)
+    end
   end
 end

data/lib/active_rest_client/logger.rb

@@ -21,7 +21,7 @@ module ActiveRestClient
         Rails.logger.debug(message)
       elsif @logfile
         File.open(@logfile, "a") do |f|
-          f << message
+          f << "#{message}\n"
         end
       else
         @messages << message
@@ -33,7 +33,7 @@ module ActiveRestClient
         Rails.logger.info(message)
       elsif @logfile
         File.open(@logfile, "a") do |f|
-          f << message
+          f << "#{message}\n"
         end
       else
         @messages << message
@@ -45,7 +45,7 @@ module ActiveRestClient
         Rails.logger.warn(message)
       elsif @logfile
         File.open(@logfile, "a") do |f|
-          f << message
+          f << "#{message}\n"
         end
       else
         @messages << message
@@ -57,7 +57,7 @@ module ActiveRestClient
         Rails.logger.error(message)
       elsif @logfile
         File.open(@logfile, "a") do |f|
-          f << message
+          f << "#{message}\n"
         end
       else
         @messages << message

data/lib/active_rest_client/request.rb

@@ -7,13 +7,14 @@ module ActiveRestClient
     attr_accessor :post_params, :get_params, :url, :path, :headers, :method, :object, :body, :forced_url, :original_url
 
     def initialize(method, object, params = {})
-      @method                  = method
-      @method[:options]        ||= {}
-      @method[:options][:lazy] ||= []
-      @overriden_name          = @method[:options][:overriden_name]
-      @object                  = object
-      @params                  = params
-      @headers                 = HeadersList.new
+      @method                     = method
+      @method[:options]           ||= {}
+      @method[:options][:lazy]    ||= []
+      @method[:options][:has_one] ||= {}
+      @overriden_name             = @method[:options][:overriden_name]
+      @object                     = object
+      @params                     = params
+      @headers                    = HeadersList.new
     end
 
     def object_is_class?
@@ -201,18 +202,17 @@ module ActiveRestClient
 
     def append_get_parameters
       if @get_params.any?
-        params = @get_params.map {|k,v| "#{k}=#{CGI.escape(v.to_s)}"}
-        @url += "?" + params.sort * "&"
+        @url += "?" + @get_params.to_query
       end
     end
 
     def prepare_request_body(params = nil)
       if request_body_type == :form_encoded
-        @body ||= (params || @post_params || {}).map {|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.sort * "&"
+        @body ||= (params || @post_params || {}).to_query
         headers["Content-Type"] ||= "application/x-www-form-urlencoded"
       elsif request_body_type == :json
         @body ||= (params || @post_params || {}).to_json
-        headers["Content-Type"] ||= "application/json"
+        headers["Content-Type"] ||= "application/json; charset=utf-8"
       end
     end
 
@@ -355,6 +355,9 @@ module ActiveRestClient
       if @method[:options][:has_many][name]
         overriden_name = name
         object = @method[:options][:has_many][name].new
+      elsif @method[:options][:has_one][name]
+        overriden_name = name
+        object = @method[:options][:has_one][name].new
       else
         if object_is_class?
           object = @object.new
@@ -369,15 +372,16 @@ module ActiveRestClient
 
       attributes.each do |k,v|
         k = k.to_sym
+        overriden_name = select_name(k, overriden_name)
         if @method[:options][:lazy].include?(k)
-          object._attributes[k] = ActiveRestClient::LazyAssociationLoader.new(overriden_name || k, v, self, overriden_name:(overriden_name||k))
+          object._attributes[k] = ActiveRestClient::LazyAssociationLoader.new(overriden_name, v, self, overriden_name:(overriden_name))
         elsif v.is_a? Hash
-          object._attributes[k] = new_object(v, overriden_name || k)
+          object._attributes[k] = new_object(v, overriden_name )
         elsif v.is_a? Array
           object._attributes[k] = ActiveRestClient::ResultIterator.new
           v.each do |item|
             if item.is_a? Hash
-              object._attributes[k] << new_object(item, overriden_name || k)
+              object._attributes[k] << new_object(item, overriden_name)
             else
               object._attributes[k] << item
             end
@@ -444,6 +448,14 @@ module ActiveRestClient
 
     private
 
+    def select_name(name, parent_name)
+      if @method[:options][:has_many][name] || @method[:options][:has_one][name]
+        return name
+      end
+
+      parent_name || name
+    end
+
     def is_json_response?
       @response.headers['Content-Type'].nil? || @response.headers['Content-Type'].include?('json')
     end

data/lib/active_rest_client/version.rb

@@ -1,3 +1,3 @@
 module ActiveRestClient
-  VERSION = "1.0.7"
+  VERSION = "1.0.8"
 end

data/spec/lib/configuration_spec.rb

@@ -108,6 +108,32 @@ describe ActiveRestClient::Configuration do
     expect(LazyLoadingConfigurationExample2.lazy_load?).to be_truthy
   end
 
+  describe 'api auth' do
+    context 'default' do
+      it "should be false using_api_auth?" do
+        expect(ActiveRestClient::Base.using_api_auth?).to be_falsey
+      end
+    end
+
+    context 'setting api auth credentials' do
+      before(:each) do
+        ConfigurationExample.api_auth_credentials('id123', 'secret123')
+      end
+
+      it "should remember setting using_api_auth?" do
+        expect(ConfigurationExample.using_api_auth?).to be_truthy
+      end
+
+      it "should remember setting api_auth_access_id" do
+        expect(ConfigurationExample.api_auth_access_id).to eq('id123')
+      end
+
+      it "should remember setting api_auth_secret_key" do
+        expect(ConfigurationExample.api_auth_secret_key).to eq('secret123')
+      end
+    end
+  end
+
   it "should default to non-verbose loggingg" do
     class VerboseConfigurationExample1
       include ActiveRestClient::Configuration

data/spec/lib/connection_spec.rb

@@ -98,6 +98,37 @@ describe ActiveRestClient::Connection do
     end
   end
 
+  context 'with api auth signing requests' do
+    before(:each) do
+      ActiveRestClient::Base.api_auth_credentials('id123', 'secret123')
+
+      @default_headers = {'Date' => 'Sat, 14 Mar 2015 15:13:24 GMT'}
+
+      ActiveRestClient::Base.faraday_config do |faraday|
+        faraday.adapter ActiveRestClient::Base.adapter
+        faraday.headers.update(@default_headers)
+      end
+      @connection.reconnect
+    end
+
+    it 'should have an Authorization header' do
+      stub_request(:get, "www.example.com/foo")
+        .with(:headers => @default_headers)
+        .to_return(body: "{result:true}")
+      result = @connection.get("/foo")
+      expect(result.env.request_headers['Authorization']).to eq("APIAuth id123:PMWBThkB8vKbvUccHvoqu9G3eVk=")
+    end
+
+    it 'should have an Content-MD5 header' do
+      stub_request(:put, "www.example.com/foo").
+        with(body: "body", :headers => @default_headers).
+        to_return(body: "{result:true}")
+
+      result = @connection.put("/foo", "body")
+      expect(result.env.request_headers['Content-MD5']).to eq("hBotaJrYa9FhFEdFPCLG/A==")
+    end
+  end
+
   it "should retry once in the event of a connection failed" do
     stub_request(:get, "www.example.com/foo").to_raise(Faraday::Error::ConnectionFailed.new("Foo"))
     expect { @connection.get("/foo") }.to raise_error(ActiveRestClient::ConnectionFailedException)

data/spec/lib/logger_spec.rb

@@ -28,22 +28,22 @@ describe ActiveRestClient::Instrumentation do
     ActiveRestClient::Logger.logfile = "/dev/null"
     file = double('file')
     expect(File).to receive(:open).with("/dev/null", "a").and_yield(file)
-    expect(file).to receive(:<<).with("Hello world")
+    expect(file).to receive(:<<).with("Hello world\n")
     ActiveRestClient::Logger.debug("Hello world")
 
     file = double('file')
     expect(File).to receive(:open).with("/dev/null", "a").and_yield(file)
-    expect(file).to receive(:<<).with("Hello info")
+    expect(file).to receive(:<<).with("Hello info\n")
     ActiveRestClient::Logger.info("Hello info")
 
     file = double('file')
     expect(File).to receive(:open).with("/dev/null", "a").and_yield(file)
-    expect(file).to receive(:<<).with("Hello error")
+    expect(file).to receive(:<<).with("Hello error\n")
     ActiveRestClient::Logger.error("Hello error")
 
     file = double('file')
     expect(File).to receive(:open).with("/dev/null", "a").and_yield(file)
-    expect(file).to receive(:<<).with("Hello warn")
+    expect(file).to receive(:<<).with("Hello warn\n")
     ActiveRestClient::Logger.warn("Hello warn")
   end
 

data/spec/lib/request_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe ActiveRestClient::Request do
   before :each do
     class ExampleOtherClient < ActiveRestClient::Base ; end
+    class ExampleSingleClient < ActiveRestClient::Base ; end
     class ExampleClient < ActiveRestClient::Base
       base_url "http://www.example.com"
       request_body_type :form_encoded
@@ -21,6 +22,7 @@ describe ActiveRestClient::Request do
 
       get :all, "/", :has_many => {:expenses => ExampleOtherClient}
       get :babies, "/babies", :has_many => {:children => ExampleOtherClient}
+      get :single_association, "/single", :has_one => {:single => ExampleSingleClient}, :has_many => {:children => ExampleOtherClient}
       get :headers, "/headers"
       put :headers_default, "/headers_default"
       put :headers_json, "/headers_json", request_body_type: :json
@@ -135,6 +137,11 @@ describe ActiveRestClient::Request do
     ExampleClient.update id:1234, debug:true
   end
 
+  it "should pass through 'array type' get parameters" do
+    expect_any_instance_of(ActiveRestClient::Connection).to receive(:get).with("/?include%5B%5D=your&include%5B%5D=friends", an_instance_of(Hash)).and_return(OpenStruct.new(body:"{\"result\":true}", headers:{}))
+    ExampleClient.all :include => [:your,:friends]
+  end
+
   it "should encode the body in a form-encoded format by default" do
     expect_any_instance_of(ActiveRestClient::Connection).to receive(:put).with("/put/1234", "debug=true&test=foo", an_instance_of(Hash)).and_return(OpenStruct.new(body:"{\"result\":true}", headers:{}))
     ExampleClient.update id:1234, debug:true, test:'foo'
@@ -163,7 +170,7 @@ describe ActiveRestClient::Request do
   end
 
   it "should set request header with content-type for JSON" do
-    expect_any_instance_of(ActiveRestClient::Connection).to receive(:put).with("/headers_json", "{}", hash_including("Content-Type" => "application/json")).and_return(OpenStruct.new(body:'{"result":true}', headers:{}))
+    expect_any_instance_of(ActiveRestClient::Connection).to receive(:put).with("/headers_json", "{}", hash_including("Content-Type" => "application/json; charset=utf-8")).and_return(OpenStruct.new(body:'{"result":true}', headers:{}))
     ExampleClient.headers_json
   end
 
@@ -236,6 +243,18 @@ describe ActiveRestClient::Request do
     expect(object.children.eldest.first).to be_instance_of(ExampleOtherClient)
   end
 
+  it "should instantiate other classes using has_one when required to do so" do
+    expect_any_instance_of(ActiveRestClient::Connection).to receive(:get).with("/single", an_instance_of(Hash)).and_return(OpenStruct.new(body:"{\"first_name\":\"Johnny\", \"single\":{\"name\":\"Billy\"}}", status:200, headers:{}))
+    object = ExampleClient.single_association
+    expect(object.single).to be_instance_of(ExampleSingleClient)
+  end
+
+  it "should instantiate other classes using has_one even if nested off the root" do
+    expect_any_instance_of(ActiveRestClient::Connection).to receive(:get).with("/single", an_instance_of(Hash)).and_return(OpenStruct.new(body:"{\"first_name\":\"Johnny\", \"children\":[{\"single\":{\"name\":\"Billy\"}}, {\"single\":{\"name\":\"Sharon\"}}]}", status:200, headers:{}))
+    object = ExampleClient.single_association
+    expect(object.children.first.single).to be_instance_of(ExampleSingleClient)
+  end
+
   it "should assign new attributes to the existing object if possible" do
     expect_any_instance_of(ActiveRestClient::Connection).
       to receive(:post).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_rest_client
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Which Ltd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,6 +151,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: api-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement