conduit 0.2.6

data/lib/conduit/storage.rb

@@ -0,0 +1,37 @@
+#
+# The job of this class is to provide storage
+# functionality for conduit.
+#
+# TODO: Support multiple storage providers
+#
+
+require 'conduit/storage/aws'
+require 'conduit/storage/file'
+
+module Conduit
+  module Storage
+
+    # Wrapper around the configuration object
+    #
+    # Configurable in:
+    # config/initializers/conduit.rb
+    #
+    def self.config
+      Configuration.storage_config
+    end
+
+    # Get the name of the chosen provider
+    # from the configuration
+    #
+    def self.provider
+      Configuration.storage_config[:provider]
+    end
+
+    # Load in the functionality for the storage provider
+    # that was selected via the configuration
+    #
+    storage_provider_module = const_get(provider.to_s.humanize)
+    extend storage_provider_module
+
+  end
+end

data/lib/conduit/storage/aws.rb

@@ -0,0 +1,94 @@
+#
+# The job of this class is to provide storage
+# functionality for conduit.
+#
+# TODO: Support multiple storage providers
+#
+
+require 'aws-sdk'
+
+module Conduit
+  module Storage
+    module Aws
+      extend ActiveSupport::Rescuable
+
+      def self.extended(base)
+        base.extend(ClassMethods)
+        base.send(:configure)
+      end
+
+      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.
+        #
+        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])
+          end
+        end
+
+        # Primary connection object to AWS::S3
+        #
+        # Configurable in:
+        # config/initializers/conduit.rb
+        # TODO: Update how conduit gets
+        # the credentials for s3
+        #
+        def connection
+          @connection ||= AWS::S3.new
+        end
+
+        # Bucket we want to work with
+        #
+        # Configurable in:
+        # config/initializers/conduit.rb
+        #
+        def bucket
+          @bucket ||= begin
+            bucket = config[:bucket]
+            connection.buckets.create(bucket) unless connection.buckets[bucket].exists?
+            connection.buckets[bucket]
+          end
+        end
+
+        # Write a file to AWS::S3
+        #
+        # e.g.
+        # => Conduit::Storage.write('/path/to/file', 'foo')
+        #
+        def write(key, content)
+          bucket.objects[key].write(content)
+        end
+
+        # Read a file from AWS::S3
+        #
+        # e.g.
+        # => Conduit::Storage.read('/path/to/file')
+        #
+        def read(key)
+          bucket.objects[key].read
+        rescue AWS::S3::Errors::NoSuchKey
+          nil
+        end
+
+        # Delete a file from AWS::S3
+        #
+        # e.g.
+        # => Conduit::Storage.delete('/path/to/file')
+        #
+        def delete(key)
+          bucket.objects[key].delete
+        rescue AWS::S3::Errors::NoSuchKey
+          nil
+        end
+
+      end
+
+    end
+  end
+end

data/lib/conduit/storage/file.rb

@@ -0,0 +1,74 @@
+#
+# The job of this class is to provide storage
+# functionality for conduit.
+#
+# TODO: Support multiple storage providers
+#
+
+require 'fileutils'
+require 'pathname'
+
+module Conduit
+  module Storage
+    module File
+
+      #
+      # TODO: Rename this, I originally used file,
+      #       not considering the fact that it's
+      #       already used in ruby.
+      #
+
+      def self.extended(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        # Return a Pathname object for the
+        # configured file path
+        #
+        def storage_path
+          @storage_path ||= Pathname.new(config[:file_path])
+        end
+
+        # Write a file to AWS::S3
+        #
+        # e.g.
+        # => Conduit::Storage.write('/path/to/file', 'foo')
+        #
+        def write(key, content)
+          full_path = storage_path.join(key)
+          FileUtils.mkdir_p(::File.dirname(full_path))
+
+          ::File.open(full_path, 'w') do |f|
+            f.write(content)
+          end
+        end
+
+        # Read a file
+        #
+        # e.g.
+        # => Conduit::Storage.read('/path/to/file')
+        #
+        def read(key)
+          ::File.read(storage_path.join(key))
+        rescue Errno::ENOENT
+          nil
+        end
+
+        # Delete a file
+        #
+        # e.g.
+        # => Conduit::Storage.delete('/path/to/file')
+        #
+        def delete(key)
+          ::File.delete(storage_path.join(key))
+        rescue Errno::ENOENT, Errno::EPERM
+          nil
+        end
+
+      end
+
+    end
+  end
+end

data/lib/conduit/util.rb

@@ -0,0 +1,17 @@
+module Conduit
+  module Util
+
+    # Instantiate the action class with options
+    #
+    # returns:
+    # => Conduit::Driver::Fusion::Purchase
+    #
+    def self.find_driver(*args)
+      driver = args.map(&:to_s).map(&:classify).join('::')
+      Conduit::Driver.const_get(driver)
+    rescue NameError
+      # TODO: Determine the best course of action for failure
+    end
+
+  end
+end

data/lib/conduit/version.rb

@@ -0,0 +1,3 @@
+module Conduit
+  VERSION = "0.2.6"
+end

data/lib/tasks/conduit_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :conduit do
+#   # Task goes here
+# end

data/spec/classes/acts_as_conduit_subscriber_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+# Create a temporary ActiveRecord object to test with
+#
+class MySubscriber < ActiveRecord::Base
+  acts_as_conduit_subscriber
+
+  # Update the `updated_at` timestamp
+  # so we know this has been called
+  #
+  def after_conduit_update(action, parsed_response)
+    self.update_column(:updated_at, 1.day.from_now)
+  end
+end
+
+describe MySubscriber do
+
+  # Silly magic to create an empty table for MySubscriber
+  #
+  before(:all) do
+    ActiveRecord::Migration.tap do |a|
+      a.verbose = false
+      a.create_table(:my_subscribers) do |t|
+        t.timestamps
+      end
+    end
+  end
+
+  # Silly magic to remove an empty table for MySubscriber
+  #
+  after(:all) do
+    ActiveRecord::Migration.tap do |a|
+      a.verbose = false
+      a.drop_table(:my_subscribers)
+    end
+  end
+
+  context 'without an instance' do
+    its(:class) { should respond_to(:acts_as_conduit_subscriber) }
+    it { should have_many :conduit_requests }
+  end
+
+  context 'with an instance' do
+    before(:each) do
+      Excon.stub({}, body: read_support_file("xml/xml_response.xml"), status: 200)
+
+      @obj = MySubscriber.create
+      @obj.conduit_requests.create(driver: :my_driver, action: :foo,
+        options: request_attributes).perform_request
+    end
+
+    describe '#after_conduit_update' do
+      it 'gets called after a request is updated' do
+        @obj.reload # Bust the cache
+        @obj.updated_at.should_not == @obj.created_at
+      end
+    end
+
+  end
+
+end

data/spec/classes/core/action_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+shared_examples_for Conduit::Core::Action do
+
+  subject do
+    described_class.new(request_attributes)
+  end
+
+  context 'without an instance' do
+    its(:class) { should respond_to(:remote_url)          }
+    its(:class) { should respond_to(:required_attributes) }
+    its(:class) { should respond_to(:optional_attributes) }
+
+    describe '.requirements' do
+      it 'returns an array of required attributes' do
+        subject.class.requirements.should == %i(foo bar baz).to_set
+      end
+    end
+
+    describe '.attributes' do
+      it 'returns an array of known attributes' do
+        subject.class.requirements.should == %i(foo bar baz).to_set
+      end
+    end
+  end
+
+  context 'with an instance' do
+    describe '#view' do
+      it 'returns a rendered view for an action' do
+        a = subject.view.gsub(/\s+/, '')
+        b = read_support_file('xml/xml_request.xml').gsub(/\s+/, '')
+        a.should == b
+      end
+    end
+
+    describe '#perform' do
+      it 'returns a 200 status' do
+        subject.perform.status.should == 200
+      end
+
+      it 'returns a response body' do
+        a = subject.perform.body.gsub(/\s+/, '')
+        b = read_support_file('xml/xml_response.xml').gsub(/\s+/, '')
+        a.should == b
+      end
+    end
+  end
+
+end
+
+describe Conduit::Driver::MyDriver::Foo do
+  it_behaves_like Conduit::Core::Action
+end

data/spec/classes/core/driver_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+shared_examples_for Conduit::Core::Driver do
+
+  context 'without an instance' do
+    describe '.credentials' do
+      it 'returns an array of required credentials' do
+        subject.credentials.should == %i(username password).to_set
+      end
+    end
+
+    describe '.actions' do
+      it 'returns an array of known action' do
+        subject.actions.should == %i(foo).to_set
+      end
+    end
+
+  end
+
+end
+
+describe Conduit::Driver::MyDriver do
+  it_behaves_like Conduit::Core::Driver
+end

data/spec/controllers/responses_controller_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Conduit::ResponsesController do
+
+  let(:request) do
+    Conduit::Request.create(driver: :my_driver,
+      action: :foo, options: request_attributes)
+  end
+
+  let(:xml_content) do
+    read_support_file('xml/xml_response.xml')
+  end
+
+  describe 'create' do
+    before do
+      post :create, { request_id: request.id,
+        content: xml_content, use_route: :conduit }
+    end
+
+    it 'returns a 200 status' do
+      response.status.should == 200
+    end
+
+    it 'creates a response object' do
+      request.responses.length.should == 1
+    end
+  end
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks