conduit 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74042f34cbbd0e62cd7b38412d5aee3188dd2f0c
-  data.tar.gz: 070cdb6f7cebfc9d53013bc21b95b35acb3d72c7
+  metadata.gz: 79be33c1882943bb158bcd403b0f4d40491df8fe
+  data.tar.gz: 739d6d61d288369a9598c4b8518db0e4a043aaaa
 SHA512:
-  metadata.gz: 9e9166923c8f53dda87b9b8df3e307e8acc98231b16c3f9b9902d9db8ef98f095d60d796a51e9a99dbe5057340d3db31e5f57121416a15410b4afeb558c6b5d0
-  data.tar.gz: a298a62148b83b3fdbb2dffc983a909744a24926cfffdf44bd3f8095d69c83cef7d1ae8592e551b2502db58fd5c4ed7f7859998e3b122360b6159076360c8973
+  metadata.gz: bfea45c3620b3ef19080e35cbb28e614b83c306f282fe5c94ae229ac275b114185cfe64a4f13b66eebdc9560ec069fafc6500ec1e582217d2edb4c9c46892b8c
+  data.tar.gz: a4780423b228734f538b1791edccdc1625e237469804ab35d5cc23a1c9597b4a56ada871353deaa5cceaef504e8309fa731f5b4bd5dd980d613c1236c630fb5b

data/lib/conduit/core/driver.rb

@@ -5,7 +5,9 @@
 # e.g.
 # => module Conduit::Driver
 # =>   class MyDriver < Conduit::Core::Driver
-# =>     required_credentials :foo, :bar, :baz
+# =>     required_credentials :username, :password
+# =>     required_attributes  :subdomain
+# =>     optional_attributes  :quux
 # =>
 # =>     action :purchase
 # =>     action :activate
@@ -35,6 +37,35 @@ module Conduit
         credentials.merge(args)
       end
 
+      # Set required attributes
+      # Useful for specifying attributes that
+      # MUST be set for every request.
+      #
+      # e.g.
+      # required_attributes :foo, :bar, :baz
+      # => <Set {:foo, :bar, :baz}>
+      #
+      def required_attributes(*args)
+        required_attribute_set.tap do |attrs|
+          attrs.merge(args)
+        end
+      end
+
+      # Set optional attributes
+      # Useful for specifying overrides and other
+      # attributes that MAY be set for every
+      # request.
+      #
+      # e.g.
+      # optional_attributes :quux
+      # => <Set {:quux}>
+      #
+      def optional_attributes(*args)
+        optional_attribute_set.tap do |attrs|
+          attrs.merge(args)
+        end
+      end
+
       # Set available actions
       #
       # e.g.
@@ -56,6 +87,16 @@ module Conduit
         @credentials ||= Set.new
       end
 
+      # Storage array for permitted attributes
+      #
+      # e.g.
+      # Conduit::Driver::Fusion.permitted_attributes
+      # => <Set {:foo, :bar, :baz, :quuz}>
+      #
+      def permitted_attributes
+        required_attribute_set + optional_attribute_set
+      end
+
       # Storage array for required credentials
       #
       # e.g.
@@ -78,6 +119,18 @@ module Conduit
         self.name.demodulize.underscore.downcase
       end
 
+      # Returns the current set of required attributes
+      #
+      def required_attribute_set
+        @required_attribute_set ||= Set.new
+      end
+
+      # Returns the current set of optional attributes
+      #
+      def optional_attribute_set
+        @optional_attribute_set ||= Set.new
+      end
+
     end
   end
 end

data/lib/conduit/version.rb

@@ -1,3 +1,3 @@
 module Conduit
-  VERSION = '0.5.3'
+  VERSION = '0.6.0'
 end

data/spec/classes/core/driver_spec.rb

@@ -15,6 +15,24 @@ shared_examples_for Conduit::Core::Driver do
       end
     end
 
+    describe '.permitted_attributes' do
+      it 'returns the union of required and optional attributes' do
+        subject.permitted_attributes.should == %i(subdomain mock).to_set
+      end
+    end
+
+    describe 'required_attributes' do
+      it 'should return only the required attributes' do
+        subject.required_attributes.should eql %i(subdomain).to_set
+      end
+    end
+
+    describe 'optional_attributes' do
+      it 'should return only the optional attributes' do
+        subject.optional_attributes.should eql %i(mock).to_set
+      end
+    end
+
   end
 
 end

data/spec/support/my_driver/driver.rb

@@ -2,6 +2,8 @@ module Conduit::Driver::MyDriver
   extend Conduit::Core::Driver
 
   required_credentials :username, :password
+  required_attributes  :subdomain
+  optional_attributes  :mock
   action :foo
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conduit
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Mike Kelley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport