shutl_resource 0.10.6 → 0.11.0

data/lib/shutl/resource/configuration.rb

@@ -28,19 +28,11 @@ module Shutl::Resource
 
   module Configuration
     class << self
-      attr_accessor :base_uri
+      attr_accessor :base_uri, :logging_enabled
 
       def configure
         yield self
       end
-
-      def logger
-        @logger ||= Logger.new($stdout)
-      end
-
-      def logger=(logger)
-        @logger = logger
-      end
     end
   end
 end

data/lib/shutl/resource/rest.rb

@@ -14,14 +14,8 @@ module Shutl::Resource
     attr_reader :response
 
     def self.included(base)
-      base.send :include, HTTParty
       base.send :extend,  Shutl::Resource::RestClassMethods
 
-      base.send :headers, {
-        'Accept'        => 'application/json',
-        'Content-Type'  => 'application/json'
-      }
-
       base.send :resource_name, base.name.split('::').last.underscore
       base.send :resource_id,   :id
     end

data/lib/shutl/resource/rest_class_methods.rb

@@ -1,5 +1,29 @@
 module Shutl::Resource
   module RestClassMethods
+    def base_uri uri
+      @base_uri = uri
+    end
+
+    def connection
+      @connection ||= Faraday.new(:url => @base_uri || Shutl::Resource.base_uri) do |faraday|
+        faraday.request :url_encoded # form-encode POST params
+        faraday.response :logger if Shutl::Resource.logging_enabled
+        faraday.response :json
+
+        # faraday.ssl[:ca_file] = ENV["SSL_CERT_FILE"]
+
+        faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
+      end
+    end
+
+    def headers
+      {
+        'Accept'        => 'application/json',
+        'Content-Type'  => 'application/json',
+        'User-Agent'    => "Shutl Resource Gem v#{Shutl::Resource::VERSION}"
+      }
+    end
+
     def find(args = {}, params = {})
       params = args if @singular_resource
       auth_options = { auth: params.delete(:auth), from: params.delete(:from) }
@@ -14,13 +38,13 @@ module Shutl::Resource
         url = member_url args.dup, params
       end
 
-      response     = get url, headers_with_auth(auth_options)
+      response     = connection.get(url) do |req|
+        req.headers = headers_with_auth(auth_options)
+      end
 
       check_fail response, "Failed to find #{name}! args: #{args}, params: #{params}"
 
-      parsed = response.parsed_response
-
-      including_parent_attributes = parsed[@resource_name].merge args
+      including_parent_attributes = response.body[@resource_name].merge args
       new_object including_parent_attributes, response
     end
 
@@ -28,40 +52,41 @@ module Shutl::Resource
       url = generate_collection_url attributes
       attributes.delete "response"
 
-      response = post(
-        url,
-        { body: { @resource_name => attributes }.to_json }.merge(headers_with_auth(options))
-      )
+      response = connection.post(url) do |req|
+        req.headers = headers_with_auth(options)
+        req.body = { @resource_name => attributes }.to_json
+      end
 
       check_fail response, "Create failed"
 
-      parsed     = response.parsed_response || {}
+      parsed     = response.body || {}
       attributes = parsed[@resource_name] || {}
 
       new_object attributes, response
     end
 
     def destroy instance, options = {}
-      message = "Failed to destroy #{name.downcase.pluralize}"
+      failure_message = "Failed to destroy #{name.downcase.pluralize}"
 
       perform_action(
         instance,
         :delete,
+        {},
         headers_with_auth(options),
-        message
+        failure_message
       ).success?
     end
 
     def save instance, options = {}
-      #TODO: this is sometimes a hash and sometimes a Rest - need to rethink this
       attributes = instance.attributes rescue instance
 
-      payload = {
-        body: { @resource_name => convert_new_id(attributes) }.to_json
-      }
+      body = { @resource_name => convert_new_id(attributes) }.to_json
 
-      payload_with_headers = payload.merge(headers_with_auth options)
-      response             = perform_action(instance, :put, payload, "Save failed")
+      response = perform_action(instance,
+                                :put,
+                                body,
+                                headers_with_auth(options),
+                                "Save failed")
 
       response.success?
     end
@@ -79,11 +104,13 @@ module Shutl::Resource
       params   = partition.last.inject({}) { |h, pair| h[pair.first] = pair.last; h }
 
       url      = generate_collection_url url_args, params
-      response = get url, headers_with_auth(auth_options)
+      response = connection.get(url) do |req|
+        req.headers = headers_with_auth(auth_options)
+      end
 
       check_fail response, "Failed to find all #{name.downcase.pluralize}"
 
-      response_object = response.parsed_response[@resource_name.pluralize].map do |h|
+      response_object = response.body[@resource_name.pluralize].map do |h|
         new_object(args.merge(h), response)
       end
       if order_collection?
@@ -94,7 +121,7 @@ module Shutl::Resource
         end
       end
 
-      RestCollection.new(response_object, response.parsed_response['pagination'])
+      RestCollection.new(response_object, response.body['pagination'])
     end
 
     class RestCollection
@@ -204,15 +231,17 @@ module Shutl::Resource
         h['Authorization'] = "Bearer #{options[:auth]}" if options[:auth]
         h['From'] = "#{options[:from]}" if options[:from]
       end
-      { headers: headers }
     end
 
-    def perform_action instance, verb, args, failure_message
+    def perform_action instance, verb, body, headers, failure_message
       attributes = instance.is_a?(Hash) ? instance : instance.attributes
       attributes.delete "response" #used in debugging requests/responses
 
       url      = member_url attributes
-      response = send verb, url, args
+      response = connection.send(verb, url) do |req|
+        req.headers = headers
+        req.body = body
+      end
 
       check_fail response, failure_message
 
@@ -223,7 +252,7 @@ module Shutl::Resource
       instance = new add_resource_id_to(args), response
 
       instance.tap do |i|
-        parsed_response = response.parsed_response
+        parsed_response = response.body
 
         if errors = (parsed_response and parsed_response["errors"])
           i.errors = errors
@@ -232,8 +261,7 @@ module Shutl::Resource
     end
 
     def check_fail response, message
-      c             = response.code
-      failure_klass = case c
+      failure_klass = case response.status
                       when 299
                         if Shutl::Resource.raise_exceptions_on_no_quotes_generated
                           Shutl::NoQuotesGenerated
@@ -264,7 +292,7 @@ module Shutl::Resource
 
 
       output = begin
-                 response.parsed_response["errors"]["base"]
+                 response.body["errors"]["base"]
                rescue
                  message
                end
@@ -277,8 +305,6 @@ module Shutl::Resource
     def generate_url!(url_pattern, args, params = {})
       url = url_pattern.dup
 
-      url = "#{Shutl::Resource.base_uri}#{url}" unless self.base_uri
-
       args, url = replace_args_from_pattern! args, url
 
       url = URI.escape url

data/lib/shutl/resource/version.rb

@@ -1,5 +1,5 @@
 module Shutl
   module Resource
-    VERSION = '0.10.6'
+    VERSION = '0.11.0'
   end
 end

data/lib/shutl_resource.rb

@@ -1,6 +1,9 @@
 module Shutl
 end
 
+require 'faraday'
+require 'faraday_middleware'
+
 require 'shutl_auth'
 require 'shutl/resource/configuration'
 require 'shutl/resource/rest'
@@ -10,7 +13,7 @@ require 'shutl/resource/errors'
 module Shutl::Resource
   extend self
 
-  delegate :logger, :logger=, :base_uri, :base_uri=, to: Configuration
+  delegate :logging_enabled, :logging_enabled=, :base_uri, :base_uri=, to: Configuration
 
   def configure(*args, &block)
     Configuration.configure(*args, &block)

data/shutl_resource.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'httparty', '~> 0.10.0'
   gem.add_dependency 'shutl_auth', '0.8.0'
   gem.add_dependency 'activemodel'
+  gem.add_dependency 'faraday'
+  gem.add_dependency 'faraday_middleware'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 2.11.0'

data/spec/configuration_spec.rb

@@ -2,18 +2,6 @@ require 'spec_helper'
 
 describe Shutl::Resource do
   describe '#configure' do
-    let(:logger) { Shutl::Resource.logger }
-
-    it 'should configure the logger' do
-      logger = stub('logger')
-
-      Shutl::Resource.configure do |config|
-        config.logger = logger
-      end
-
-      Shutl::Resource.logger.should == logger
-    end
-
     it "allows for configuration of the base uri" do
       Shutl::Resource.configure do |config|
         config.base_uri = 'base uri'

data/spec/rest_resource_spec.rb

@@ -2,14 +2,9 @@ require 'spec_helper'
 
 describe Shutl::Resource::Rest do
   let(:headers) do
-    { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }
-  end
-
-  it 'should include the REST verb' do
-    TestRest.should respond_to :get
-    TestRest.should respond_to :post
-    TestRest.should respond_to :post
-    TestRest.should respond_to :delete
+    { 'Accept' => 'application/json',
+      'Content-Type' => 'application/json',
+      'User-Agent' => "Shutl Resource Gem v#{Shutl::Resource::VERSION}" }
   end
 
   let(:resource) { TestRest.new(a: 'a', b: 2) }

data/spec/spec_helper.rb

@@ -5,4 +5,7 @@ require 'support/test_resource'
 require 'support/test_resource'
 require 'support/configured_base_uri_resource'
 require 'support/test_singular_resource'
-require 'support/double_logger'
+
+Shutl::Resource.configure do |config|
+  config.logging_enabled = false
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shutl_resource
 version: !ruby/object:Gem::Version
-  version: 0.10.6
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70172591200440 !ruby/object:Gem::Requirement
+  requirement: &70223946241460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *70172591200440
+  version_requirements: *70223946241460
 - !ruby/object:Gem::Dependency
   name: shutl_auth
-  requirement: &70172591199320 !ruby/object:Gem::Requirement
+  requirement: &70223946238100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -34,10 +34,10 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70172591199320
+  version_requirements: *70223946238100
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70172591198300 !ruby/object:Gem::Requirement
+  requirement: &70223946237240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,32 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70172591198300
+  version_requirements: *70223946237240
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70223946267260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70223946267260
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &70223946264740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70223946264740
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70172591220740 !ruby/object:Gem::Requirement
+  requirement: &70223946262780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70172591220740
+  version_requirements: *70223946262780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70172591214620 !ruby/object:Gem::Requirement
+  requirement: &70223946289820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,10 +89,10 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70172591214620
+  version_requirements: *70223946289820
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70172591232420 !ruby/object:Gem::Requirement
+  requirement: &70223946284400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +100,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70172591232420
+  version_requirements: *70223946284400
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70172591231420 !ruby/object:Gem::Requirement
+  requirement: &70223946301380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -89,7 +111,7 @@ dependencies:
         version: 1.8.7
   type: :development
   prerelease: false
-  version_requirements: *70172591231420
+  version_requirements: *70223946301380
 description: Shutl Rest resource
 email:
 - davidr@shutl.co.uk
@@ -123,7 +145,6 @@ files:
 - spec/rest_resource_spec.rb
 - spec/spec_helper.rb
 - spec/support/configured_base_uri_resource.rb
-- spec/support/double_logger.rb
 - spec/support/test_resource.rb
 - spec/support/test_singular_resource.rb
 homepage: ''
@@ -140,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -655986128022496311
+      hash: -4070568380889602956
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -655986128022496311
+      hash: -4070568380889602956
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -164,6 +185,5 @@ test_files:
 - spec/rest_resource_spec.rb
 - spec/spec_helper.rb
 - spec/support/configured_base_uri_resource.rb
-- spec/support/double_logger.rb
 - spec/support/test_resource.rb
 - spec/support/test_singular_resource.rb

data/spec/support/double_logger.rb

@@ -1,14 +0,0 @@
-
-module Shutl::Resource
-  class NoLogger
-    def debug(message) ; end
-    def info(message) ; end
-    def warn(message) ; end
-    def error(message) ; end
-    def fatal(message) ; end
-  end
-end
-
-Shutl::Resource.configure do |config|
-  config.logger = Shutl::Resource::NoLogger.new
-end