conduit 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aef71bc68a9d9085d6cdae58a21a60cb6709124b
-  data.tar.gz: 6e9d85b0aa5a0ec98fb1a3ac90bfcd5833d8a88b
+  metadata.gz: 3152108f595eb0bd81712bbdc9dae55fe09d3771
+  data.tar.gz: 75290c49ca35147c1f4a9dc35d753f51f60e2655
 SHA512:
-  metadata.gz: 95d5163cf0ae501b624e37d2f95b76503b4c7683338319c1bc1fcf03e4e7796c3e550d093164209828688a6ee4187adf464e15de9637d50022871f30b85e117e
-  data.tar.gz: 88a27616a8fc3a67fa5042520386c3d445f87611bcfa8cf1ad15dea54de6942083a6ad56e584e832b9a3959b9c8b7afdde65fdbeebeb4d8247e6f85f52b7b7f2
+  metadata.gz: 65e9a1464fe147247106035fad8ac057551ddbb90f8e34af1a3b7923175fd8e468b75983769a7d879e9050bee744d42be2aec6890a019f8413de46c96edd40ca
+  data.tar.gz: 5999fe406736a0d60b2f494677bd423115c15e6b91d9534185a7163b630d4290e0bb60b2c68210a3aee9afc3fec79b06964fb78dc0b3d3efe3f71ef3281b574b

data/lib/conduit.rb

@@ -1,4 +1,4 @@
-$:.unshift File.dirname(__FILE__)
+$LOAD_PATH.unshift File.dirname(__FILE__)
 
 require 'conduit/configuration'
 
@@ -8,8 +8,10 @@ module Conduit
   # NOTE: Autoloading should be
   #       concurrency-safe
   #
-  autoload :Storage,           'conduit/storage'
-  autoload :Util,              'conduit/util'
+  autoload :Storage,      'conduit/storage'
+  autoload :Util,         'conduit/util'
+  autoload :Response,     'conduit/response'
+  autoload :TimeOut,      'conduit/time_out'
 
   module Core
 
@@ -22,7 +24,6 @@ module Conduit
     autoload :Action,     'conduit/core/action'
     autoload :Parser,     'conduit/core/parser'
     autoload :Driver,     'conduit/core/driver'
-
   end
 
   module Driver
@@ -42,9 +43,9 @@ module Conduit
       #
       def load_drivers
         Conduit.configuration.driver_paths.each do |dir|
-          raise "Directory not found: #{dir}" unless File.exists?(dir)
+          raise "Directory not found: #{dir}" unless File.exist?(dir)
           Dir["#{dir}/**/driver.rb"].each do |file|
-            raise "File not found: #{file}" unless File.exists?(file)
+            raise "File not found: #{file}" unless File.exist?(file)
             name = File.dirname(file).split(File::SEPARATOR).last.classify.to_sym
             index << name.downcase
             autoload name, file

data/lib/conduit/core/action.rb

@@ -98,7 +98,7 @@ module Conduit
         # used.
         #
         def view_context
-          OpenStruct.new(@options.select do |k,v|
+          OpenStruct.new(@options.select do |k, v|
             attributes.include?(k)
           end)
         end
@@ -125,23 +125,34 @@ module Conduit
         # Override to customize.
         #
         def perform
-          request(body: view, method: :post)
+          response = request(body: view, method: :post)
+          parser   = parser_class.new(response.body)
+
+          Conduit::Response.new(raw_response: response,
+            parser: parser)
         end
 
         private
 
-          # Ensures that all required attributes are present
-          # If not all attributes are present, will raise
-          # an ArgumentError listing missing attributes
-          #
-          def validate!(options)
-            missing_keys = (requirements.to_a - options.keys)
-            if missing_keys.any?
-              raise ArgumentError,
-                "Missing keys: #{missing_keys.join(', ')}"
-            end
+        # Ensures that all required attributes are present
+        # If not all attributes are present, will raise
+        # an ArgumentError listing missing attributes
+        #
+        def validate!(options)
+          missing_keys = (requirements.to_a - options.keys)
+          if missing_keys.any?
+            raise ArgumentError,
+              "Missing keys: #{missing_keys.join(', ')}"
           end
+        end
 
+        # Returns the parser for this action
+        # subclasses responsible for providing the
+        # response_body and response_status.
+        #
+        def parser_class
+          self.class.const_get(:Parser)
+        end
       end
 
     end

data/lib/conduit/core/connection.rb

@@ -10,7 +10,6 @@ require 'excon'
 module Conduit
   module Core
     module Connection
-
       def self.included(base)
         base.extend ClassMethods
         base.send :include, InstanceMethods
@@ -23,7 +22,7 @@ module Conduit
         # e.g.
         # remote_url 'http://myapi.com/endpoint'
         #
-        def remote_url(host=nil)
+        def remote_url(host = nil)
           @remote_url ||= host
         end
 
@@ -51,37 +50,39 @@ module Conduit
           params[:headers] ||= {}
           params[:headers]['User-Agent'] ||= "conduit/#{Conduit::VERSION}"
           connection.request(params, &block)
+        rescue Excon::Errors::Timeout => timeout
+          raise(Conduit::Errors::Timeout, timeout.message)
         end
 
         private
 
-          # Connection that will be used
-          #
-          # @param [Hash] params
-          # @option params [String] :body Default text to be sent over a socket. Only used if :body absent in Connection#request params
-          # @option params [Hash<Symbol, String>] :headers The default headers to supply in a request. Only used if params[:headers] is not supplied to Connection#request
-          # @option params [String] :host The destination host's reachable DNS name or IP, in the form of a String
-          # @option params [String] :path Default path; appears after 'scheme://host:port/'. Only used if params[:path] is not supplied to Connection#request
-          # @option params [Fixnum] :port The port on which to connect, to the destination host
-          # @option params [Hash]   :query Default query; appended to the 'scheme://host:port/path/' in the form of '?key=value'. Will only be used if params[:query] is not supplied to Connection#request
-          # @option params [String] :scheme The protocol; 'https' causes OpenSSL to be used
-          # @option params [String] :proxy Proxy server; e.g. 'http://myproxy.com:8888'
-          # @option params [Fixnum] :retry_limit Set how many times we'll retry a failed request.  (Default 4)
-          # @option params [Class] :instrumentor Responds to #instrument as in ActiveSupport::Notifications
-          # @option params [String] :instrumentor_name Name prefix for #instrument events.  Defaults to 'excon'
-          #
-          # @return [Excon::Response]
-          #
-          # @raise [Excon::Errors::StubNotFound]
-          # @raise [Excon::Errors::Timeout]
-          # @raise [Excon::Errors::SocketError]
-          #
-          def connection(**params)
-            @excon ||= Excon.new(remote_url, params)
-          end
+        # Connection that will be used
+        #
+        # @param [Hash] params
+        # @option params [String] :body Default text to be sent over a socket. Only used if :body absent in Connection#request params
+        # @option params [Hash<Symbol, String>] :headers The default headers to supply in a request. Only used if params[:headers] is not supplied to Connection#request
+        # @option params [String] :host The destination host's reachable DNS name or IP, in the form of a String
+        # @option params [String] :path Default path; appears after 'scheme://host:port/'. Only used if params[:path] is not supplied to Connection#request
+        # @option params [Fixnum] :port The port on which to connect, to the destination host
+        # @option params [Hash]   :query Default query; appended to the 'scheme://host:port/path/' in the form of '?key=value'. Will only be used if params[:query] is not supplied to Connection#request
+        # @option params [String] :scheme The protocol; 'https' causes OpenSSL to be used
+        # @option params [String] :proxy Proxy server; e.g. 'http://myproxy.com:8888'
+        # @option params [Fixnum] :retry_limit Set how many times we'll retry a failed request.  (Default 4)
+        # @option params [Class] :instrumentor Responds to #instrument as in ActiveSupport::Notifications
+        # @option params [String] :instrumentor_name Name prefix for #instrument events.  Defaults to 'excon'
+        #
+        # @return [Excon::Response]
+        #
+        # @raise [Excon::Errors::StubNotFound]
+        # @raise [Excon::Errors::Timeout]
+        # @raise [Excon::Errors::SocketError]
+        #
+        def connection(**params)
+          @excon ||= Excon.new(remote_url, params)
+        end
 
       end
 
     end
   end
-end
+end

data/lib/conduit/core/driver.rb

@@ -22,7 +22,7 @@ module Conduit
     module Driver
 
       def self.extended(base)
-        base.instance_variable_set("@_driver_path",
+        base.instance_variable_set('@_driver_path',
           File.dirname(caller.first[/^[^:]+/]))
       end
 
@@ -68,15 +68,15 @@ module Conduit
 
       private
 
-        # Return the name of the driver
-        #
-        # e.g.
-        # Conduit::Drivers::Fusion.name
-        # => "fusion"
-        #
-        def driver_name
-          self.name.demodulize.underscore.downcase
-        end
+      # Return the name of the driver
+      #
+      # e.g.
+      # Conduit::Drivers::Fusion.name
+      # => "fusion"
+      #
+      def driver_name
+        self.name.demodulize.underscore.downcase
+      end
 
     end
   end

data/lib/conduit/core/parser.rb

@@ -45,14 +45,14 @@ module Conduit
       # Should be overwritten by parser implementation.
       #
       def response_status
-        raise NoMethodError, "Please define response_status in your parser."
+        raise NoMethodError, 'Please define response_status in your parser.'
       end
 
       # Default response error container.
       # Should be overwritten by parser implementation.
       #
       def response_errors
-        raise NoMethodError, "Please define response_errors in your parser."
+        raise NoMethodError, 'Please define response_errors in your parser.'
       end
     end
   end

data/lib/conduit/core/render.rb

@@ -30,7 +30,7 @@ module Conduit
       # => render :purchase
       #
       def render(file, layout: true)
-        raise ViewPathNotDefined, "" unless view_path
+        raise ViewPathNotDefined, '' unless view_path
         layout ? render_with_layout(file) : render_template(file)
       end
 

data/lib/conduit/response.rb

@@ -0,0 +1,11 @@
+module Conduit
+  class Response
+    attr_reader :body, :parser, :raw_response
+
+    def initialize(options = {})
+      @raw_response = options[:raw_response]
+      @body         = options.fetch(:body, raw_response.body)
+      @parser       = options[:parser]
+    end
+  end
+end

data/lib/conduit/storage/aws.rb

@@ -19,16 +19,17 @@ module Conduit
 
       module ClassMethods
 
-        # Configure AWS::S3 if we have explicit config
-        #
-        # TODO: This needs to be tested against AWS IAM.
-        #       I'm thinking this being a "module"
-        #       might cause issues.
+        # Configure AWS::S3 with credentials if provided, else, assume
+        # IAM will provide them.
         #
         def configure
-          if [:aws_access_key_id, :aws_access_secret].all? { |key| config.has_key?(key) }
-            AWS.config(:access_key_id => config[:aws_access_key_id],
-              :secret_access_key => config[:aws_access_secret])
+          if [:aws_access_key_id, :aws_access_secret].all? { |key| config.key?(key) }
+            AWS.config(
+              access_key_id:     config[:aws_access_key_id],
+              secret_access_key: config[:aws_access_secret]
+            )
+          else
+            AWS.config
           end
         end
 

data/lib/conduit/time_out.rb

@@ -0,0 +1,4 @@
+module Conduit
+  class TimeOut < StandardError
+  end
+end

data/lib/conduit/version.rb

@@ -1,3 +1,3 @@
 module Conduit
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/spec/classes/core/action_spec.rb

@@ -43,14 +43,12 @@ shared_examples_for Conduit::Core::Action do
     describe '#perform' do
       before { Excon.stub({}, body: response, status: 200) }
 
-      it 'returns a 200 status' do
-        subject.perform.status.should == 200
+      it 'returns a response wrapper' do
+        subject.perform.should be_a_kind_of(Conduit::Response)
       end
 
-      it 'returns a response body' do
-        a = subject.perform.body.gsub(/\s+/, '')
-        b = response.gsub(/\s+/, '')
-        a.should == b
+      it 'should return the raw_content' do
+        subject.perform.body.should_not be_nil
       end
     end
   end

data/spec/support/helper.rb

@@ -4,7 +4,7 @@ module Helper
     {
       foo: 'value for foo',
       bar: 'value for bar',
-      baz: 'value for baz',
+      baz: 'value for baz'
     }
   end
 
@@ -12,4 +12,4 @@ module Helper
     IO.read(File.join(File.dirname(__FILE__), name))
   end
 
-end
+end

data/spec/support/my_driver/actions/foo.rb

@@ -6,5 +6,10 @@ module Conduit::Driver::MyDriver
     required_attributes :foo, :bar, :baz
     optional_attributes :buz
 
+    private
+
+    def response_class
+      Conduit::Driver::MyDriver::Response
+    end
   end
 end

data/spec/support/my_driver/parsers/foo.rb

@@ -8,15 +8,15 @@ module Conduit::Driver::MyDriver
     end
 
     attribute :foo do
-      "foo"
+      'foo'
     end
 
     attribute :bar do
-      "bar"
+      'bar'
     end
 
     attribute :baz do
-      "baz"
+      'baz'
     end
 
     # Return "success/failure". This gets
@@ -57,7 +57,7 @@ module Conduit::Driver::MyDriver
     # object_path('//resources/@timestamp')
     # => [#<Nokogiri::XML::Attr:0x3fca8b040818 name="timestamp" value="20140130180057">]
     #
-    def object_path(path, node=doc)
+    def object_path(path, node = doc)
       node.xpath(path)
     end
 
@@ -67,7 +67,7 @@ module Conduit::Driver::MyDriver
     # string_path('//resources/@timestamp')
     # => 20140130180057
     #
-    def string_path(path, node=doc)
+    def string_path(path, node = doc)
       object_path(path, node).to_s
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conduit
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Kelley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,9 +136,11 @@ files:
 - lib/conduit/core/parser.rb
 - lib/conduit/core/render.rb
 - lib/conduit/drivers/keep
+- lib/conduit/response.rb
 - lib/conduit/storage/aws.rb
 - lib/conduit/storage/file.rb
 - lib/conduit/storage.rb
+- lib/conduit/time_out.rb
 - lib/conduit/util.rb
 - lib/conduit/version.rb
 - lib/conduit.rb