actionkit_connector 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e16a7ee6f6fa3884352858162d9e633191c65a78
-  data.tar.gz: 1993fbb2afe1cba96fbdb876497be2e234af7193
+  metadata.gz: 4eeb4b6e7d0bde25857028d38896ff19d78b604a
+  data.tar.gz: b1fc898fca46658d916db5019725a7a12da08255
 SHA512:
-  metadata.gz: 4b6d0a6854ae046da9da1a5356d17ead15e6a026e56319ebba3f408594d8f4315ea5eafc548b303ac4724a11aa7f31a29a0c8b45d7bd5d0f7cf4e0698dd90534
-  data.tar.gz: aacd7d4f95e0e5269d86a33dc9a9681ce4805036749163d467f1208b82b3fd2fde23f17f47abd6214cdaa9a97cb023f57534a07c0681f1d609d5e6c83034403a
+  metadata.gz: 580bd61fe4bfbcb047d65b3188d762d6192168774d2241625c84496204dc2138498eb4b7481dcfca8329913c0491529909b0e5ee3a4c50dbc0705d7ec6b62eb1
+  data.tar.gz: cc98ec77802888dcc844dc7d8306350bd957fc9e1440f83ffdaf3f64fde51acbbbddf0369637f2172f0863367ebd576daf68ce92decf6af56b503e7a65c61de8

data/lib/actionkit_connector/version.rb

@@ -1,3 +1,3 @@
 module ActionkitConnector
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/lib/actionkit_connector.rb

@@ -137,6 +137,22 @@ module ActionKitConnector
       self.class.post(target, options)
     end
 
+    # Creates an action which registers a donation with a user account.
+    #
+    # @param [Hash] options The hash of values sent to ActionKit which contain information about this transaction.
+    def create_donation_action(options={})
+      target = "#{self.base_url}/donationpush/"
+      options = self.validate_donation_options(options)
+      page_opts = {
+          basic_auth: self.auth,
+          body: options.to_json,
+          headers: {
+              'Content-Type' => 'application/json'
+          }
+      }
+      self.class.post(target, page_opts)
+    end
+
     def parse_action_options(options)
       included_options = {}
       acceptable_options = [
@@ -154,5 +170,51 @@ module ActionKitConnector
       end
       included_options
     end
+
+    def validate_donation_options(options)
+      required_base_keys = [:donationpage, :order, :user]
+      if required_base_keys.all? {|s| options.key? s}
+        options[:donationpage] = validate_donationpage_options(options[:donationpage])
+        options[:order] = validate_donation_order_options(options[:order])
+        options[:user] = validate_donation_user_options(options[:user])
+      else
+        raise 'Donation options require donationpage, order and user keys in the base hash.'
+      end
+      options
+    end
+
+    def validate_donationpage_options(options)
+      required_base_keys = [:name, :payment_account]
+      if required_base_keys.all? {|s| options.key? s}
+        options
+      else
+        raise 'Donation Page options require name and payment_account keys in the hash.'
+      end
+    end
+
+    def validate_donation_order_options(options)
+      required_base_keys = [:amount, :exp_date_month, :exp_date_year]
+      if required_base_keys.all? {|s| options.key? s}
+        if options[:card_num].nil?
+          options[:card_num] = '4111111111111111' # Default placeholder card number.
+        end
+
+        if options[:card_code].nil?
+          options[:card_code] = '007' # Default AK Card Code.
+        end
+      else
+        raise 'Donation Order options require amount, exp_date_month and exp_date_year keys.'
+      end
+      options
+    end
+
+    def validate_donation_user_options(options)
+      required_base_keys = [:email, :country]
+      if required_base_keys.all? {|s| options.key? s}
+        options
+      else
+        raise 'Donation User options require email and country keys in the hash.'
+      end
+    end
   end
 end

data/spec/connector_spec.rb

@@ -63,5 +63,105 @@ describe 'Connector' do
         with(body: request_body)
     end
   end
+
+  # Used for the donation validations below.
+  let(:full_donation_options) {
+    {
+        donationpage: {
+            name: 'donation',
+            payment_account: 'Default Import Stub'
+        },
+        order: {
+            amount: '1',
+            card_num: '4111111111111111',
+            card_code: '007',
+            exp_date_month: '01',
+            exp_date_year: '2016'
+        },
+        user: {
+            email: 'eric@sumofus.org',
+            country: 'United States',
+        }
+    }
+  }
+
+  describe '#create_donation_action' do
+    let(:request_body) {
+      full_donation_options.to_json
+    }
+
+    before do
+      stub_request(:post, "http://username:password@api.example.com/donationpush/").
+          with(body: request_body)
+    end
+
+    it 'creates a donationpush action' do
+      client.create_donation_action(full_donation_options)
+      expect(WebMock).to have_requested(:post, 'http://username:password@api.example.com/donationpush/').
+        with(body: request_body, headers: {'Content-Type' => 'application/json'})
+    end
+  end
+
+  describe 'donation validation methods' do
+    let(:expected_donationpage) {
+      full_donation_options[:donationpage]
+    }
+    let(:expected_order) {
+      full_donation_options[:order]
+    }
+    let(:expected_user) {
+      full_donation_options[:user]
+    }
+    describe '#validate_donation_options' do
+      it 'sends back the correct options when provided a valid hash' do
+        expect(client.validate_donation_options(full_donation_options)).to eq(full_donation_options)
+      end
+
+      it 'raises when provided an incorrect set of base hash values' do
+        expect { client.validate_donation_options({}) }.to raise_error(RuntimeError)
+      end
+    end
+
+    describe '#validate_donationpage_options' do
+      it 'sends back the correct options when provided a valid hash' do
+        expect(client.validate_donationpage_options(expected_donationpage)).to eq(expected_donationpage)
+      end
+
+      it 'raises when provided an incorrect set of hash values' do
+        expect { client.validate_donationpage_options({}) }.to raise_error(RuntimeError)
+      end
+    end
+
+    describe '#validate_donation_user_options' do
+      it 'sends back the correct options when provided a valid hash' do
+        expect(client.validate_donation_user_options(expected_user)).to eq(expected_user)
+      end
+
+      it 'raises when provided an incorrect set of hash values' do
+        expect { client.validate_donation_user_options({}) }.to raise_error(RuntimeError)
+      end
+    end
+
+    describe '#validate_donation_order_options' do
+      it 'sends back the correct options when provided a correct hash' do
+        expect(client.validate_donation_order_options(expected_order)).to eq(expected_order)
+      end
+
+      it 'raises when provided an incorrect set of hash values' do
+        expect { client.validate_donation_order_options({}) }.to raise_error(RuntimeError)
+      end
+
+      it 'fills in default values if they are not provided' do
+        sent_values = expected_order.tap { |hash|
+          hash.delete(:card_num)
+          hash.delete(:card_code)
+        }
+        expect(client.validate_donation_order_options(sent_values)).to eq(expected_order)
+      end
+    end
+
+  end
+
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionkit_connector
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Eric Boersma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A gem for interacting with the ActionKit API.