conduit 0.2.6

data/lib/conduit/core/action.rb

@@ -0,0 +1,136 @@
+#
+# The job of this class is to provide common
+# functionality to a action class.
+#
+# e.g.
+# => class MyAction < Conduit::Core::Action
+# =>   required_attributes :foo, :bar
+# =>   optional_attributes :baz
+# => end
+#
+# => action = MyAction.new(foo: 'foo', bar: 'bar', baz: 'baz')
+# => action.perform
+#
+
+require 'set'
+
+module Conduit
+  module Core
+    class Action
+
+      def self.inherited(base)
+        base.send :include, Conduit::Core::Connection
+        base.send :include, Conduit::Core::Render
+        base.send :include, InstanceMethods
+        base.extend ClassMethods
+
+        # TODO: Move this to the driver scope
+        #       which allows for setting this
+        #       "globally" for the driver.
+        #
+        path = caller.first[/^[^:]+/]
+        define_method(:action_path) do
+          File.dirname(path)
+        end
+      end
+
+      module ClassMethods
+
+        attr_accessor :_action_path
+
+        # Set required attributes
+        #
+        # e.g.
+        # => required_attributes :foo, :bar, :baz
+        #
+        def required_attributes(*args)
+          requirements.merge(args)
+          attributes.merge(args)
+        end
+
+        # Set optional attributes
+        #
+        # e.g.
+        # => optional_attributes :foo, :bar, :baz
+        #
+        def optional_attributes(*args)
+          attributes.merge(args)
+        end
+
+        # Storage array for required attributes
+        #
+        def requirements
+          @requirements ||= Set.new
+        end
+
+        # Storage array for all attributes
+        #
+        def attributes
+          @attributes ||= Set.new
+        end
+
+      end
+
+      module InstanceMethods
+
+        delegate :requirements, :attributes, to: :class
+
+        def initialize(**options)
+          @options = options
+          validate!(options)
+        end
+
+        # Object used for passing data to the view
+        # Only keys listed in attributes will be
+        # used.
+        #
+        def view_context
+          OpenStruct.new(@options.select do |k,v|
+            attributes.include?(k)
+          end)
+        end
+
+        # Location where the view files can be found
+        # Default to lib/conduit/drivers/<drivername>/views
+        # Can be overriden per class.
+        #
+        def view_path
+          File.join(File.dirname(action_path), 'views')
+        end
+
+        # Return the rendered view
+        #
+        def view
+          tpl = self.class.name.demodulize
+            .underscore.downcase
+          render(tpl)
+        end
+
+        # Entry method. The class will use
+        # use this to trigger the request.
+        #
+        # Override to customize.
+        #
+        def perform
+          request(body: view, method: :post)
+        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
+          end
+
+      end
+
+    end
+  end
+end

data/lib/conduit/core/connection.rb

@@ -0,0 +1,85 @@
+#
+# The job of this module is to handle network
+# communication rom Conduit to a remote host.
+#
+
+require 'conduit/version'
+require 'excon'
+
+module Conduit
+  module Core
+    module Connection
+
+      def self.included(base)
+        base.extend ClassMethods
+        base.send :include, InstanceMethods
+      end
+
+      module ClassMethods
+
+        # Define a remote_url
+        #
+        # e.g.
+        # remote_url 'http://myapi.com/endpoint'
+        #
+        def remote_url(host=nil)
+          @remote_url ||= host
+        end
+
+      end
+
+      module InstanceMethods
+
+        delegate :remote_url, to: :class
+
+        # Make a request
+        #
+        # @param [Hash] params
+        # @option params [String] :body text to be sent over a socket
+        # @option params [Hash<Symbol, String>] :headers The default headers to supply in a request
+        # @option params [String] :host The destination host's reachable DNS name or IP, in the form of a String
+        # @option params [String] :path appears after 'scheme://host:port/'
+        # @option params [Fixnum] :port The port on which to connect, to the destination host
+        # @option params [Hash]   :query appended to the 'scheme://host:port/path/' in the form of '?key=value'
+        # @option params [String] :scheme The protocol; 'https' causes OpenSSL to be used
+        # @option params [Proc] :response_block
+        #
+        #
+        def request(params, &block)
+          params[:headers] ||= {}
+          params[:headers]['User-Agent'] ||= "conduit/#{Conduit::VERSION}"
+          connection.request(params, &block)
+        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
+
+      end
+
+    end
+  end
+end

data/lib/conduit/core/driver.rb

@@ -0,0 +1,83 @@
+#
+# The job of this class is to require all
+# actions belonging to this driver
+#
+# e.g.
+# => module Conduit::Driver
+# =>   class MyDriver < Conduit::Core::Driver
+# =>     required_credentials :foo, :bar, :baz
+# =>
+# =>     action :purchase
+# =>     action :activate
+# =>     action :suspend
+# =>
+# =>   end
+# => end
+#
+
+require 'set'
+
+module Conduit
+  module Core
+    module Driver
+
+      def self.extended(base)
+        base.instance_variable_set("@_driver_path",
+          File.dirname(caller.first[/^[^:]+/]))
+      end
+
+      # Set required credentials
+      #
+      # e.g.
+      # => required_credentials :foo, :bar, :baz
+      #
+      def required_credentials(*args)
+        credentials.merge(args)
+      end
+
+      # Set available actions
+      #
+      # e.g.
+      # => action :purchase
+      #
+      def action(action_name)
+        require File.join(@_driver_path, 'actions', action_name.to_s)
+        require File.join(@_driver_path, 'parsers', action_name.to_s)
+        actions << action_name
+      end
+
+      # Storage array for required credentials
+      #
+      # e.g.
+      # Conduit::Driver::Fusion.credentials
+      # => [:foo, :bar, :baz]
+      #
+      def credentials
+        @credentials ||= Set.new
+      end
+
+      # Storage array for required credentials
+      #
+      # e.g.
+      # Conduit::Driver::Fusion.actions
+      # => [:purchase]
+      #
+      def actions
+        @actions ||= Set.new
+      end
+
+      private
+
+        # Return the name of the driver
+        #
+        # e.g.
+        # Conduit::Drivers::Fusion.name
+        # => "fusion"
+        #
+        def driver_name
+          self.name.demodulize.underscore.downcase
+        end
+
+    end
+  end
+end

data/lib/conduit/core/parser.rb

@@ -0,0 +1,55 @@
+#
+# The job of this class is parse a raw response
+# and provide parsed attributes that can be
+# predictably consumed.
+#
+module Conduit
+  module Core
+    class Parser
+
+      class << self
+
+        # Define an attribute that will be publically exposed
+        # when dealing with conduit responses.
+        #
+        def attribute(attr_name, &block)
+          attributes << attr_name
+          define_method(attr_name, &block)
+        end
+
+        # Storage array for all attributes
+        #
+        def attributes
+          @attributes ||= []
+        end
+
+      end
+
+      delegate :attributes, to: :class
+
+      # Returns a hash representation of each attribute
+      # defined in a parser and its value.
+      #
+      def serializable_hash
+        attributes.inject({}) do |hash, attribute|
+          hash.tap { |h| h[attribute] = send(attribute) }
+        end
+      end
+
+      # Default response status.
+      # Should be overwritten by parser implementation.
+      #
+      def response_status
+        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."
+      end
+  
+    end
+  end
+end

data/lib/conduit/core/render.rb

@@ -0,0 +1,69 @@
+#
+# The job of this module is to provide template
+# rendering functionality. Included classes
+# must provide a view_path, and view_context
+# methods to be of any use.
+#
+
+require 'tilt'
+
+module Conduit
+  module Core
+    module Render
+
+      # Create instance variables, any of these can
+      # be overriden within the including class.
+      #
+      # view_path:    Location where the view files are stored
+      # view_context: Object that contains the variables used in the template
+      #
+      def self.included(base)
+        attr_accessor :view_path, :view_context
+      end
+
+      # Render a template file
+      #
+      # e.g. Without layout
+      # => render :purchase, layout: false
+      #
+      # e.g. With layout
+      # => render :purchase
+      #
+      def render(file, layout: true)
+        raise ViewPathNotDefined, "" unless view_path
+        layout ? render_with_layout(file) : render_template(file)
+      end
+
+      # Render a template file
+      #
+      # e.g. Without layout
+      # => render_template(:template)
+      #
+      # e.g. With layout
+      # => render_template(:layout) do
+      # =>   render_template(:template)
+      # => end
+      #
+      def render_template(file)
+        path = File.join(view_path, "#{file}.erb")
+        Tilt::ERBTemplate.new(path).render(view_context) do
+          yield if block_given?
+        end
+      end
+
+      # Render the file with a layout
+      #
+      # e.g.
+      # => render_layout(:template)
+      #
+      def render_with_layout(file)
+        render_template(:layout) do
+          render_template(file)
+        end
+      end
+
+      class ViewPathNotDefined < StandardError; end
+
+    end
+  end
+end

data/lib/conduit/engine.rb

@@ -0,0 +1,20 @@
+module Conduit
+  class Engine < ::Rails::Engine
+    isolate_namespace Conduit
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.assets false
+      g.helper false
+    end
+
+    initializer "conduit.load_app_root", before: :load_config_initializers do |app|
+      Conduit.app_root = app.root
+    end
+
+    initializer 'conduit.load_drivers', after: :load_config_initializers do |app|
+      Conduit::Driver.load_drivers
+    end
+
+  end
+end