conduit 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae57ae862cb89c3d6032192b7b6222021568d612
-  data.tar.gz: 25b4c001510e51d24235fd591c86b38284d56840
+  metadata.gz: ff4f0e5f7f702375659f970ab9ed86f2ce673ca7
+  data.tar.gz: 88ebd51ff6273ba6dad93c01d60f0b78851ddfec
 SHA512:
-  metadata.gz: f2ee68b71fbbef5c52dce91b3d9edc8e7add2186d658f8e69b757c00e0ef8c41fd9bfad33e880ae9dfebe9e0539244d9f749efd1d6284751133c714c6a7caa03
-  data.tar.gz: d33c3ffb5dd8c8bd900cd5ff0decc534939ef9334e0ae2b9160c82bfe007557c13858169b75b17f8245ec455fb471d2a62da9a7168e17fd51998b103f0f62ed0
+  metadata.gz: 6106383b60779d51424c96d3319c439a76498c6bc33918f4cdf5363deb6da42666144054210b93bcc0bdb44f4f24e75aa80b9cfd2138f2472d65c977b596a129
+  data.tar.gz: 2b6eeb302b22fc3d3e91eb46555d3ad5eeb3c6e698288f2c1624733b02cf39de54a22456a833f5fef969d9ac1e815fcd2d0d5b1d65ce696e9fcafd5669aedc37

data/bin/conduit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "conduit/cli"
+
+Conduit::CLI.start

data/lib/conduit.rb

@@ -23,6 +23,8 @@ module Conduit
     #
     autoload :Connection,     'conduit/core/connection'
     autoload :Render,         'conduit/core/render'
+    autoload :Decorator,      'conduit/core/decorator'
+    autoload :RequestMocker,  'conduit/core/request_mocker'
     autoload :Action,         'conduit/core/action'
     autoload :Parser,         'conduit/core/parser'
     autoload :Driver,         'conduit/core/driver'

data/lib/conduit/blueprints/actions/base.tt

@@ -0,0 +1,21 @@
+#
+# Base action class that all driver actions should extend.
+# Common actions functionality goes here.
+#
+
+module Conduit::Driver::<%= classified_name %>
+  class Base < Conduit::Core::Action
+    class << self
+      def inherited(base)
+        base.send :required_attributes, *Conduit::Driver::<%= classified_name %>.credentials
+        base.send :required_attributes, *Conduit::Driver::<%= classified_name %>.required_attributes
+        base.send :optional_attributes, *Conduit::Driver::<%= classified_name %>.optional_attributes
+      end
+    end
+
+    def remote_url
+      # TODO: Define API endpoint here:
+      # http://example.com/api
+    end
+  end
+end

data/lib/conduit/blueprints/base.tt

@@ -0,0 +1,9 @@
+require "conduit"
+require "conduit/<%= underscored_name %>/driver"
+require "conduit/<%= underscored_name %>/version"
+require "conduit/<%= underscored_name %>/request_mocker"
+require "conduit/<%= underscored_name %>/decorators"
+
+Conduit.configure do |config|
+  config.driver_paths << File.join(File.dirname(__FILE__), "<%= underscored_name %>")
+end

data/lib/conduit/blueprints/bin/generate_action.tt

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "conduit/<%= underscored_name %>/generators/action"
+
+Conduit::<%= classified_name %>::Generators::Action.start

data/lib/conduit/blueprints/decorators.tt

@@ -0,0 +1,2 @@
+mocks = File.join(File.dirname(__FILE__), "decorators", "*.rb")
+Dir.glob(mocks) { |fname| require fname }

data/lib/conduit/blueprints/decorators/base.tt

@@ -0,0 +1,9 @@
+#
+# Base decorator class that all action decorators should extend.
+# Common decorator functionality goes here.
+#
+
+module Conduit::<%= classified_name %>::Decorators
+  class Base < Conduit::Core::Decorator
+  end
+end

data/lib/conduit/blueprints/driver.tt

@@ -0,0 +1,14 @@
+require "conduit/<%= underscored_name %>/actions/base"
+
+module Conduit
+  module Driver
+    # Conduit Driver for <%= classified_name %>
+    module <%= classified_name %>
+      extend Conduit::Core::Driver
+
+      # TODO: replace `required_credentials` and `optional_attributes` as needed
+      required_credentials :username, :password
+      optional_attributes  :mock_status
+    end
+  end
+end

data/lib/conduit/blueprints/generators/action.tt

@@ -0,0 +1,61 @@
+require "thor/group"
+require "active_support"
+require "byebug"
+
+module Conduit
+  module <%= classified_name %>
+    module Generators
+      class Action < Thor::Group
+        include Thor::Actions
+
+        attr_reader :classified_name
+        attr_reader :underscored_name
+
+        argument :name, type: :string
+
+        def initialize(*args)
+          super
+          @classified_name = ActiveSupport::Inflector.classify name
+          @underscored_name = ActiveSupport::Inflector.underscore name
+          @driver_path = "#{File.dirname(__FILE__)}/.."
+          @spec_path = "#{@driver_path}/../../../spec"
+        end
+
+        def copy_action
+          template("action.tt", "#{@driver_path}/actions/#{@underscored_name}.rb")
+        end
+
+        def copy_decorator
+          template("decorator.tt", "#{@driver_path}/decorators/#{@underscored_name}.rb")
+        end
+
+        def copy_parser
+          template("parser.tt", "#{@driver_path}/parsers/#{@underscored_name}.rb")
+        end
+
+        def copy_mocks
+          template("mock.tt", "#{@driver_path}/request_mocker/#{@underscored_name}.rb")
+          create_file "#{@driver_path}/request_mocker/fixtures/responses/#{@underscored_name}/success.xml.erb"
+          create_file "#{@driver_path}/request_mocker/fixtures/responses/#{@underscored_name}/failure.xml.erb"
+        end
+
+        def copy_view
+          create_file "#{@driver_path}/views/#{@underscored_name}.erb"
+        end
+
+        def add_action_to_driver
+          insert_into_file("#{@driver_path}/driver.rb", "\n      action :#{@underscored_name}\n", after: "optional_attributes  :mock_status\n")
+        end
+
+        def add_spec_files
+          template("rspec_action.tt", "#{@spec_path}/conduit/<%= underscored_name %>/actions/#{@underscored_name}_spec.rb")
+          create_file "#{@spec_path}/fixtures/requests/#{@underscored_name}/request.xml"
+        end
+
+        def self.source_root
+          "#{File.dirname(__FILE__)}/blueprints"
+        end
+      end
+    end
+  end
+end

data/lib/conduit/blueprints/generators/blueprints/action.tt

@@ -0,0 +1,13 @@
+require_relative "base"
+
+module Conduit::Driver::<%= classified_name %>
+  class <%%= classified_name %> < Conduit::Driver::<%= classified_name %>::Base
+    operation :<%%= underscored_name %>
+
+    # Required attributes go here
+    # required_attributes :required_attribute_name
+
+    # Optional attributes go here
+    # optional_attributes :optional_attribute_name
+  end
+end

data/lib/conduit/blueprints/generators/blueprints/decorator.tt

@@ -0,0 +1,6 @@
+require_relative "base"
+
+module Conduit::<%= classified_name %>::Decorators
+  class <%%= classified_name %>Decorator < Base
+  end
+end

data/lib/conduit/blueprints/generators/blueprints/mock.tt

@@ -0,0 +1,7 @@
+require_relative "base"
+
+module Conduit::<%= classified_name %>::RequestMocker
+  # Request mocker for <%%= underscored_name %>.
+  class <%%= classified_name %> < Base
+  end
+end

data/lib/conduit/blueprints/generators/blueprints/parser.tt

@@ -0,0 +1,8 @@
+require_relative "base"
+
+module Conduit::Driver::<%= classified_name %>
+  class <%%= classified_name %>::Parser < Parser::Base
+    # Specify attributes here:
+    # attribute :attr_name
+  end
+end

data/lib/conduit/blueprints/generators/blueprints/rspec_action.tt

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe <%%= classified_name %> do
+end

data/lib/conduit/blueprints/parsers/base.tt

@@ -0,0 +1,121 @@
+#
+# Base parser class that all request parsers should extend.
+# Common parser functionality goes here.
+#
+# It uses nokogiri to extract attributes from the xml response.
+#
+
+require "nokogiri"
+require "active_support"
+
+module Conduit::Driver::<%= classified_name %>
+  module Parser
+    # Provides the base functionality for parsing
+    # XML responses from the api
+    class Base < Conduit::Core::Parser
+      attr_accessor :xml
+
+      # Extracts the camelized attribute from the xml response
+      def self.attribute(attr_name, &block)
+        block ||= lambda do
+          content_for "//#{ActiveSupport::Inflector.camelize(attr_name, false)}"
+        end
+        super(attr_name, &block)
+      end
+
+      def initialize(xml)
+        @xml = xml
+      end
+
+      def root
+        @root ||= Nokogiri::XML(xml).tap do |doc|
+          doc.remove_namespaces!
+        end
+      end
+
+      # Get the attribute value at a certain path
+      def content_for(path, doc = root)
+        node = doc.at_xpath(path)
+        node.content if node
+      end
+
+      # Returns the following:
+      #
+      # - `acknowledged` when async
+      # - `success` when successful
+      # - `failure` when unsuccessful
+      def response_status
+        if response_errors.any?
+          "failure"
+        elsif in_progress?
+          "acknowledged"
+        else
+          "success"
+        end
+      end
+
+      # Returns normalized request errors if present.
+      def response_errors
+        if response_content?
+          if !content_for("//Fault").nil?
+            [normalized_fault]
+          else
+            # Returns empty array if no errors
+            normalized_errors
+          end
+        else
+          [Conduit::Error.new(message: "Unexpected response from server.")]
+        end
+      end
+
+      # Indicates if content present.
+      def response_content?
+        # TODO: replace this if response not present in `Body`
+        !content_for("//Body").nil?
+      end
+
+      private
+
+      # Indicates if a request is in progress. Used for async requests.
+      # Should be overwritten in the action's parser in case true.
+      def in_progress?
+        false
+      end
+
+      # Returns a new `Conduit::Error` instance containing the fault text
+      # and the fault code.
+      def normalized_fault
+        # TODO: replace this if error message and code not present in the
+        # below paths
+        Conduit::Error.new({
+          message: content_for("//Fault//Text"),
+          code: content_for("//Fault//Code//Value")
+        })
+      end
+
+      # Extracts the error from either `errorMessage` or `errorText`
+      def error_response
+        # TODO: replace this if error response not present in any of the following
+        # paths.
+        content_for("//errorMessage") || content_for("//errorText")
+      end
+
+      # Returns a new `Conduit::Error` instance containing the error message and
+      # its code.
+      def normalized_errors
+        # TODO: replace this if error not present in `error_message` and code
+        # not present in `errorNumber`
+        if error_response && !error_response.empty?
+          [
+            Conduit::Error.new({
+              message: error_response,
+              code: content_for("errorNumber")
+            })
+          ]
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/conduit/blueprints/request_mocker.tt

@@ -0,0 +1,2 @@
+mocks = File.join(File.dirname(__FILE__), "request_mocker", "*.rb")
+Dir.glob(mocks) { |fname| require fname }

data/lib/conduit/blueprints/request_mocker/base.tt

@@ -0,0 +1,15 @@
+#
+# Base request mocker class that all mockers should extend.
+# Common mock functionality goes here.
+#
+
+module Conduit::<%= classified_name %>::RequestMocker
+  class Base < Conduit::Core::RequestMocker
+    private
+
+    # Default path for fixtures.
+    def fixtures_path
+      "#{__dir__}/fixtures/responses"
+    end
+  end
+end

data/lib/conduit/blueprints/spec_helper.tt

@@ -0,0 +1,8 @@
+require "rspec/its"
+require "conduit/<%= underscored_name %>"
+require "rspec/matchers"
+require "equivalent-xml"
+
+include Conduit::Driver::<%= classified_name %>
+
+Dir[File.join(Dir.pwd, "spec/support/**/*.rb")].each { |file| require file }

data/lib/conduit/blueprints/support/helpers.tt

@@ -0,0 +1,12 @@
+module Helpers
+  def credentials
+    {
+      mock_status: :success
+    }
+  end
+end
+
+RSpec.configure do |config|
+  # rspec configuration goes here
+  config.include Helpers
+end

data/lib/conduit/blueprints/views/layout.tt

@@ -0,0 +1 @@
+<%%= yield %>

data/lib/conduit/cli.rb

@@ -0,0 +1,146 @@
+require "thor"
+require "active_support"
+require "bundler"
+
+module Conduit
+  class CLI < Thor
+    include Thor::Actions
+
+    attr_accessor :driver_name, :classified_name, :underscored_name, :base_path
+
+    desc "generate_driver DRIVER_NAME", "Generates a new xml `conduit-driver` gem"
+    long_desc <<-LONGDESC
+      `generate_driver DRIVER_NAME` will generate a new gem for the xml conduit
+      driver.
+
+      It will add the base `action`, `decorator`, `parser` and `request_mocker`
+      files along with generators and other basic files.
+    LONGDESC
+    def generate_driver driver_name
+      @driver_name = driver_name
+      @dasherized_name = ActiveSupport::Inflector.dasherize driver_name
+      @classified_name = ActiveSupport::Inflector.classify driver_name
+      @underscored_name = ActiveSupport::Inflector.underscore driver_name
+      @pwd = Dir.pwd
+      @base_path = "#{@pwd}/conduit-#{@dasherized_name}"
+
+      run("bundle gem conduit-#{@underscored_name} --no-coc --mit --test=rspec")
+      fix_names
+      copy_files
+      modify_files
+      run("chmod +x #{@base_path}/bin/generate_action")
+      bundle_install
+    end
+
+    private
+
+    # In case the name of the driver is composed of multiple words we need to
+    # generate the gem with an underscored named (in order to avoid nested modules
+    # for each part of the name) and then replace the gem and base file name with
+    # the dasherized one.
+    # For example, if the driver is called `best-wireless` we create `conduit-best_driver`
+    # gem and we change the name to `conduit-best-driver`
+    def fix_names
+      if @underscored_name.split("_").length > 1
+        current_path = "#{@pwd}/conduit-#{@underscored_name}"
+
+        # Change gem name in gemspec file
+        gemspec_file = "#{current_path}/conduit-#{@underscored_name}.gemspec"
+        gsub_file(gemspec_file, /spec\.name(.*)/, "spec.name          = \"conduit-#{@dasherized_name}\"")
+
+        # Rename gemspec file
+        run("mv #{gemspec_file} #{current_path}/conduit-#{@dasherized_name}.gemspec")
+
+        # Rename gem dir
+        run("mv #{current_path} #{@base_path}")
+      end
+    end
+
+    def bundle_install
+      # Taken from https://github.com/rails/rails/blob/92703a9ea5d8b96f30e0b706b801c9185ef14f0e/railties/lib/rails/generators/app_base.rb#L363
+      _bundle_command = Gem.bin_path("bundler", "bundle")
+
+      Bundler.with_clean_env do
+        inside(@base_path) do
+          full_command = %Q["#{Gem.ruby}" "#{_bundle_command}" install]
+          run(full_command)
+        end
+      end
+    end
+
+    # Indicates where the template files are located
+    def self.source_root
+      "#{__dir__}/blueprints"
+    end
+
+    # List of the template files and their destination
+    def files_to_copy
+      lib_path = "#{@base_path}/lib/conduit/#{@underscored_name}"
+
+      {
+        "base.tt" => "#{@base_path}/lib/conduit/#{@underscored_name}.rb",
+        "actions/base.tt" => "#{lib_path}/actions/base.rb",
+        "decorators/base.tt" => "#{lib_path}/decorators/base.rb",
+        "parsers/base.tt" => "#{lib_path}/parsers/base.rb",
+        "request_mocker/base.tt" => "#{lib_path}/request_mocker/base.rb",
+        "views/layout.tt" => "#{lib_path}/views/layout.erb",
+        "decorators.tt" => "#{lib_path}/decorators.rb",
+        "driver.tt" => "#{lib_path}/driver.rb",
+        "request_mocker.tt" => "#{lib_path}/request_mocker.rb",
+        "generators/action.tt" => "#{lib_path}/generators/action.rb",
+        "generators/blueprints/action.tt" => "#{lib_path}/generators/blueprints/action.tt",
+        "generators/blueprints/decorator.tt" => "#{lib_path}/generators/blueprints/decorator.tt",
+        "generators/blueprints/mock.tt" => "#{lib_path}/generators/blueprints/mock.tt",
+        "generators/blueprints/parser.tt" => "#{lib_path}/generators/blueprints/parser.tt",
+        "generators/blueprints/rspec_action.tt" => "#{lib_path}/generators/blueprints/rspec_action.tt",
+        "bin/generate_action.tt" => "#{@base_path}/bin/generate_action",
+        "support/helpers.tt" => "#{@base_path}/spec/support/helpers.rb",
+        "spec_helper.tt" => "#{@base_path}/spec/spec_helper.rb"
+      }
+    end
+
+    # Copy template files
+    def copy_files
+      files_to_copy.each do |origin, destination|
+        template(origin, destination, force: true)
+      end
+    end
+
+    # Adds missing lines to the files
+    def modify_files
+      gemspec_file = "#{@base_path}/conduit-#{@dasherized_name}.gemspec"
+
+      # add gemspec dependencies
+      str = "  # Dependencies\n"\
+            "  #\n"\
+            "  spec.add_dependency \"conduit\", \"~> 1.0.3\"\n"\
+            "  # xml parser\n"\
+            "  spec.add_dependency \"nokogiri\"\n"\
+            "  # to get string inflectors\n"\
+            "  spec.add_dependency \"activesupport\"\n\n"\
+            "  # Development Dependencies\n"\
+            "  #\n"\
+            "  spec.add_development_dependency \"shoulda-matchers\"\n"\
+            "  # to compare xml files in tests\n"\
+            "  spec.add_development_dependency \"equivalent-xml\"\n"\
+            "  spec.add_development_dependency \"rspec-its\"\n"\
+            "  # for building CLI\n"\
+            "  spec.add_development_dependency \"thor\"\n"\
+            "  # for debugging\n"\
+            "  spec.add_development_dependency \"byebug\"\n"
+
+      insert_into_file gemspec_file, str, after: "spec.require_paths = [\"lib\"]\n\n"
+
+      # remove description
+      gsub_file(gemspec_file, /spec\.description(.*)\n/, "")
+
+      # update summary
+      new_summary = "spec.summary       = \"#{ActiveSupport::Inflector.humanize @underscored_name} Driver for Conduit\""
+      gsub_file(gemspec_file, /spec\.summary(.*)/, new_summary)
+
+      # update homepage
+      new_homepage = "spec.homepage      = \"http://www.github.com/conduit/conduit-#{@dasherized_name}\""
+      gsub_file(gemspec_file, /spec\.homepage(.*)/, new_homepage)
+    end
+  end
+end

data/lib/conduit/core/action.rb

@@ -27,6 +27,7 @@ module Conduit
         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
@@ -87,22 +88,30 @@ module Conduit
         def_delegator :'self.class', :requirements
         def_delegator :'self.class', :attributes
 
-        # def requirements
-        #   self.class.requirements
-        # end
-
-        # def attributes
-        #   self.class.attributes
-        # end
-
-        # Object used for passing data to the view
-        # Only keys listed in attributes will be
-        # used.
+        # The view's context will be the action's decorator.
+        # The decorator name depends on the current action's name.
+        #
+        # For example `Conduit::MyDriver::Decorators::ActivateDecorator`
+        # will be the view's context for the `activate` action.
         #
         def view_context
-          OpenStruct.new(@options.select do |k, v|
-            attributes.include?(k)
-          end)
+          view_decorator.new(
+            OpenStruct.new(attributes_with_values)
+          )
+        end
+
+        # Returns a hash of all the defined attributes and
+        # their values.
+        #
+        # If an attribute's value is not passed as an option it
+        # will default to `nil`.
+        #
+        def attributes_with_values
+          attributes.inject({}) do |hash, attribute|
+            hash.tap do |h|
+              h[attribute] = @options[attribute]
+            end
+          end
         end
 
         # Location where the view files can be found
@@ -121,24 +130,41 @@ module Conduit
           render(tpl)
         end
 
-        # Entry method. The class will use
-        # use this to trigger the request.
+        # Method called to make the actual request.
         #
         # Override to customize.
         #
-        def perform
+        def perform_request
           response = request(body: view, method: :post)
-          parser   = parser_class.new(response.body)
+          parser_instance = parser.new(response.body)
+
+          Conduit::ApiResponse.new(raw_response: response, parser: parser_instance)
+        end
 
-          Conduit::ApiResponse.new(raw_response: response,
-            parser: parser)
+        # Entry method. Calls either the mocker or the `perform_request`
+        # method.
+        #
+        def perform
+          # When testing we can mock the request. The mocker used
+          # will depend on the action's name. For example:
+          # `Conduit::MyDriver::RequestMocker::Activate` will be responsible for
+          # mocking the `activate` action.
+          #
+          # * To mock success pass `mock_status: 'success'` as an option.
+          # * To mock failure pass `mock_status: 'failure'` as an option.
+          if mock_mode?
+            mocker = request_mocker.new(self, @options)
+            mocker.with_mocking { perform_request }
+          else
+            perform_request
+          end
         end
 
         private
 
         # Ensures that all required attributes are present
         # If not all attributes are present, will raise
-        # an ArgumentError listing missing attributes
+        # an ArgumentError listing missing attributes.
         #
         def validate!(options)
           missing_keys = (requirements.to_a - options.keys)
@@ -148,15 +174,53 @@ module Conduit
           end
         end
 
-        # Returns the parser for this action
-        # subclasses responsible for providing the
-        # response_body and response_status.
+        # Returns the capitalized action name.
+        #
+        def action_name
+          ActiveSupport::Inflector.demodulize(self.class)
+        end
+
+        # Returns the name of the driver that this action belongs to.
+        #
+        def driver_name
+          self.class.to_s.deconstantize.demodulize.underscore
+        end
+
+        # Returns the parser for this action subclasses responsible for providing
+        # the response_body and response_status.
         #
-        def parser_class
+        def parser
           self.class.const_get(:Parser)
         end
-      end
 
+        # Returns the mocker class to use based on the action's name.
+        #
+        def request_mocker
+          "Conduit::#{driver_name.classify}::RequestMocker::#{action_name}".constantize
+        end
+
+        # Returns the decorator class to use based on the action's name. If no
+        # decorator class defined, it will return the core decorator class.
+        #
+        def view_decorator
+          # In ruby 2.0.0 we can't do `const_defined? MyDriver::Decorators::FooDecorator`
+          # so we have to check each module one by one.
+          if Conduit.const_defined?(driver_name.classify) &&
+             Conduit.const_get(driver_name.classify).const_defined?("Decorators") &&
+             Conduit.const_get("#{driver_name.classify}::Decorators").const_defined?("#{action_name}Decorator")
+
+            Conduit.const_get("#{driver_name.classify}::Decorators::#{action_name}Decorator")
+          else
+            Conduit::Core::Decorator
+          end
+        end
+
+        # Indicates whether the request should be mocked or not.
+        #
+        def mock_mode?
+          @options.has_key?(:mock_status) && (!@options[:mock_status].nil? && !@options[:mock_status].empty?)
+        end
+      end
     end
   end
 end

data/lib/conduit/core/decorator.rb

@@ -0,0 +1,22 @@
+#
+# Decorators are used to act as the view's
+# context. This is where most of the logic occurs,
+# mainly where options are organized in a hash
+# for the view to serialize.
+#
+# Extend this class for every action. For example,
+# for the `activate` action, an `ActivateDecorator`
+# is defined which exposes a `line_activation_attributes` method
+# for the view.
+#
+
+require 'delegate'
+require 'forwardable'
+
+module Conduit
+  module Core
+    class Decorator < SimpleDelegator
+      extend Forwardable
+    end
+  end
+end

data/lib/conduit/core/request_mocker.rb

@@ -0,0 +1,89 @@
+#
+# Mocks action responses for testing. We can choose
+# the type of response (success, failure, error).
+#
+# Response fixtures are stored in a directory specified inside
+# `fixtures_path`. Each action has its own folder and each response file
+# is named according to the status we're mocking.
+#
+# In order to mock a request, pass the option `mock_status` to
+# the action with its value being the returned status.
+#
+
+require 'erb'
+require 'excon'
+require 'tilt'
+
+module Conduit
+  module Core
+    class RequestMocker
+      def initialize(base, options = nil)
+        @base = base
+        @options = options
+        @mock_status = options[:mock_status].to_sym || :success
+        @http_status = options[:http_status] || 200
+      end
+
+      # Starts mocking, override if using something different than
+      # excon to make the requests.
+      #
+      def mock
+        Excon.defaults[:mock] = true
+        Excon.stub({}, { body: response, status: @http_status })
+      end
+
+      # Ends mocking, override if using something different than
+      # excon to make the requests.
+      #
+      def unmock
+        Excon.defaults[:mock] = false
+        Excon.stubs.clear
+      end
+
+      # Wrapps the block inside a mocking state.
+      #
+      def with_mocking
+        mock and yield.tap { unmock }
+      end
+
+      private
+
+      def render_response
+        Tilt::ERBTemplate.new(fixture).render(@base.view_context)
+      end
+
+      def action_name
+        ActiveSupport::Inflector.demodulize(self.class.name).underscore
+      end
+
+      # Directory where fixtures are stored.
+      #
+      def fixtures_path
+        raise NoMethodError, 'Please define fixtures_path in your request mocker.'
+      end
+
+      def fixture
+        "#{fixtures_path}/#{action_name}/#{@mock_status}.xml.erb"
+      end
+
+      def response
+        if response_statuses.include?(@mock_status)
+          return error_response if @mock_status == :error
+          render_response
+        else
+          raise(ArgumentError, "Mock status must be one of the following: #{response_statuses.join(', ')}")
+        end
+      end
+
+      # Allowed statuses.
+      def response_statuses
+        %i(success failure error)
+      end
+
+      # Mocked error response.
+      def error_response
+        '{"status": 500, "error": "Internal Service Error"}'
+      end
+    end
+  end
+end

data/lib/conduit/version.rb

@@ -1,3 +1,3 @@
 module Conduit
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/spec/classes/core/action_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 shared_examples_for Conduit::Core::Action do
 
   let(:request)  { read_support_file('xml/xml_request.xml')  }
+  let(:modified_request)  { read_support_file('xml/xml_modified_request.xml')  }
   let(:response) { read_support_file('xml/xml_response.xml') }
 
   subject do
@@ -28,6 +29,19 @@ shared_examples_for Conduit::Core::Action do
   end
 
   context 'with an instance' do
+    describe '#attributes_with_values' do
+      context 'with optional attribute not set' do
+        let (:attrs) { request_attributes.merge(buz: nil) }
+        its(:attributes_with_values) { should eq(attrs) }
+      end
+
+      context 'with optional attribute set' do
+        let (:attrs) { request_attributes.merge(buz: "value for buz") }
+        subject { described_class.new(attrs) }
+        its(:attributes_with_values) { should eq(attrs) }
+      end
+    end
+
     describe '#view' do
       before do
         Excon.stub({}, body: request, status: 200)
@@ -40,6 +54,59 @@ shared_examples_for Conduit::Core::Action do
       end
     end
 
+    describe '#view_context' do
+      context 'without decorator class' do
+        it 'returns an instance of core decorator' do
+          subject.view_context.should be_a_kind_of(Conduit::Core::Decorator)
+        end
+      end
+
+      context 'with decorator class' do
+        let(:driver) { subject.class.name.deconstantize.demodulize }
+        let(:action) { subject.class.name.demodulize }
+
+        # Define decorator module programmatically:
+        let(:decorator) do
+          # Create DriverName::Decorators module
+          module TheDriver
+            module Decorators
+            end
+          end
+
+          # Add action decorator to DriverName::Decorators
+          class TheDecorator < Conduit::Core::Decorator
+            def foo
+              "new #{super}"
+            end
+
+            def baz
+              "modified baz"
+            end
+          end
+
+          # Set the above defined modules and class in Conduit
+          stub_const("TheDriver::Decorators::#{action}Decorator", TheDecorator)
+
+          TheDriver
+        end
+
+        before do
+          stub_const("Conduit::#{driver}", decorator)
+          Excon.stub({}, body: modified_request, status: 200)
+        end
+
+        it 'returns an instance of core decorator' do
+          subject.view_context.should be_a_kind_of(Conduit.const_get(driver)::Decorators::const_get("#{action}Decorator"))
+        end
+
+        it 'returns a new rendered view for an action' do
+          a = subject.view.gsub(/\s+/, '')
+          b = modified_request.gsub(/\s+/, '')
+          a.should == b
+        end
+      end
+    end
+
     describe '#perform' do
       before { Excon.stub({}, body: response, status: 200) }
 

data/spec/classes/core/request_mocker_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'excon'
+
+shared_examples_for Conduit::Core::RequestMocker do
+
+  let(:success)  { read_support_file('xml/success_mock.xml')  }
+  let(:failure)  { read_support_file('xml/failure_mock.xml')  }
+  let(:fake_action) do
+    class FakeAction
+      def view_context
+        OpenStruct.new({ value: "Yay!" })
+      end
+    end
+
+    FakeAction.new
+  end
+
+  context 'success mocking' do
+    subject { described_class.new(fake_action, { mock_status: 'success' }) }
+    let(:response) { subject.with_mocking { Excon.new('http://example.com').request }.body }
+    it 'return success response' do
+      response.should eq(success)
+    end
+  end
+
+  context 'failure mocking' do
+    subject { described_class.new(fake_action, { mock_status: 'failure' }) }
+    let(:response) { subject.with_mocking { Excon.new('http://example.com').request }.body }
+    it 'return failure response' do
+      response.should eq(failure)
+    end
+  end
+
+  context 'with disallowed response status' do
+    subject { described_class.new(fake_action, { mock_status: 'fake_status' }) }
+    let(:response) { subject.with_mocking { Excon.new('http://example.com').request }.body }
+    it 'raises and error' do
+      lambda { response }.should raise_error(ArgumentError)
+    end
+  end
+end
+
+describe Conduit::MyDriver::RequestMocker::Foo do
+  it_behaves_like Conduit::Core::RequestMocker
+end

data/spec/support/my_driver/request_mockers/fixtures/foo/failure.xml.erb

@@ -0,0 +1,4 @@
+<BeQuick product="conduit">
+  <response status="failure" action="foo" />
+  <error>Err 404</error>
+</BeQuick>

data/spec/support/my_driver/request_mockers/fixtures/foo/success.xml.erb

@@ -0,0 +1,4 @@
+<BeQuick product="conduit">
+  <response status="success" action="foo" />
+  <val><%= value %></val>
+</BeQuick>

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

@@ -0,0 +1,13 @@
+module Conduit
+  module MyDriver
+    module RequestMocker
+      class Foo < Conduit::Core::RequestMocker
+        private
+
+        def fixtures_path
+          "#{__dir__}/fixtures"
+        end
+      end
+    end
+  end
+end

data/spec/support/xml/failure_mock.xml

@@ -0,0 +1,4 @@
+<BeQuick product="conduit">
+  <response status="failure" action="foo" />
+  <error>Err 404</error>
+</BeQuick>

data/spec/support/xml/success_mock.xml

@@ -0,0 +1,4 @@
+<BeQuick product="conduit">
+  <response status="success" action="foo" />
+  <val>Yay!</val>
+</BeQuick>

data/spec/support/xml/xml_modified_request.xml

@@ -0,0 +1,7 @@
+<BeQuick product="conduit">
+  <action name="foo">
+    <foo>new value for foo</foo>
+    <bar>value for bar</bar>
+    <baz>modified baz</baz>
+  </action>
+</BeQuick>

data/spec/support/xml/xml_request.xml

@@ -1,7 +1,7 @@
-<BeQuickproduct="conduit">
+<BeQuick product="conduit">
   <action name="foo">
     <foo>value for foo</foo>
     <bar>value for bar</bar>
     <baz>value for baz</baz>
   </action>
-</BeQuick>
+</BeQuick>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conduit
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Mike Kelley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-24 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -125,20 +153,43 @@ dependencies:
 description: 
 email:
 - mike@codezombie.org
-executables: []
+executables:
+- conduit
 extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
+- bin/conduit
 - lib/conduit.rb
 - lib/conduit/api_response.rb
+- lib/conduit/blueprints/actions/base.tt
+- lib/conduit/blueprints/base.tt
+- lib/conduit/blueprints/bin/generate_action.tt
+- lib/conduit/blueprints/decorators.tt
+- lib/conduit/blueprints/decorators/base.tt
+- lib/conduit/blueprints/driver.tt
+- lib/conduit/blueprints/generators/action.tt
+- lib/conduit/blueprints/generators/blueprints/action.tt
+- lib/conduit/blueprints/generators/blueprints/decorator.tt
+- lib/conduit/blueprints/generators/blueprints/mock.tt
+- lib/conduit/blueprints/generators/blueprints/parser.tt
+- lib/conduit/blueprints/generators/blueprints/rspec_action.tt
+- lib/conduit/blueprints/parsers/base.tt
+- lib/conduit/blueprints/request_mocker.tt
+- lib/conduit/blueprints/request_mocker/base.tt
+- lib/conduit/blueprints/spec_helper.tt
+- lib/conduit/blueprints/support/helpers.tt
+- lib/conduit/blueprints/views/layout.tt
+- lib/conduit/cli.rb
 - lib/conduit/configuration.rb
 - lib/conduit/connection_error.rb
 - lib/conduit/core/action.rb
 - lib/conduit/core/connection.rb
+- lib/conduit/core/decorator.rb
 - lib/conduit/core/driver.rb
 - lib/conduit/core/parser.rb
 - lib/conduit/core/render.rb
+- lib/conduit/core/request_mocker.rb
 - lib/conduit/drivers/keep
 - lib/conduit/error.rb
 - lib/conduit/storage.rb
@@ -150,14 +201,21 @@ files:
 - spec/classes/core/action_spec.rb
 - spec/classes/core/driver_spec.rb
 - spec/classes/core/parser_spec.rb
+- spec/classes/core/request_mocker_spec.rb
 - spec/classes/util_spec.rb
 - spec/spec_helper.rb
 - spec/support/helper.rb
 - spec/support/my_driver/actions/foo.rb
 - spec/support/my_driver/driver.rb
 - spec/support/my_driver/parsers/foo.rb
+- spec/support/my_driver/request_mockers/fixtures/foo/failure.xml.erb
+- spec/support/my_driver/request_mockers/fixtures/foo/success.xml.erb
+- spec/support/my_driver/request_mockers/foo.rb
 - spec/support/my_driver/views/foo.erb
 - spec/support/my_driver/views/layout.erb
+- spec/support/xml/failure_mock.xml
+- spec/support/xml/success_mock.xml
+- spec/support/xml/xml_modified_request.xml
 - spec/support/xml/xml_request.xml
 - spec/support/xml/xml_response.xml
 homepage: https://github.com/conduit/conduit
@@ -179,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Conduit is an interface for debit platforms.
@@ -187,14 +245,20 @@ test_files:
 - spec/classes/core/action_spec.rb
 - spec/classes/core/driver_spec.rb
 - spec/classes/core/parser_spec.rb
+- spec/classes/core/request_mocker_spec.rb
 - spec/classes/util_spec.rb
 - spec/spec_helper.rb
 - spec/support/helper.rb
 - spec/support/my_driver/actions/foo.rb
 - spec/support/my_driver/driver.rb
 - spec/support/my_driver/parsers/foo.rb
+- spec/support/my_driver/request_mockers/fixtures/foo/failure.xml.erb
+- spec/support/my_driver/request_mockers/fixtures/foo/success.xml.erb
+- spec/support/my_driver/request_mockers/foo.rb
 - spec/support/my_driver/views/foo.erb
 - spec/support/my_driver/views/layout.erb
+- spec/support/xml/failure_mock.xml
+- spec/support/xml/success_mock.xml
+- spec/support/xml/xml_modified_request.xml
 - spec/support/xml/xml_request.xml
 - spec/support/xml/xml_response.xml
-has_rdoc: