act_blue_reporter 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1fb11f172ddbec69ae35cab10d2f44848e544fa
-  data.tar.gz: e92c05017f1b82855d821668cb436feff3c2904a
+  metadata.gz: 411f515f527d0305e142defeb71b2bdd9cf7be8a
+  data.tar.gz: 87ca4d91fdcf7e4b33fc1b3349b514a9a39b1544
 SHA512:
-  metadata.gz: 494af4ada1b134c599b22d804c54988b6e6c08e83086b21e80c100f103b5108d9308b133c093c543707dad57b3d4bd4e161de96656d39e7b7898b5c7c56b8791
-  data.tar.gz: ba62c8910f40feb734bfe9538b0be23ee82359be32575349a0c4298f4e21f0e231607fb33faec8e8b2dd852cc71106e221ea79e07ee2245ea3de8bbb168e1d47
+  metadata.gz: 919826db0951cfc660f1d99a91eeafbcb4f1b9746c539754a19850231564480fb99c8d1321fc5a6df405fa946965a0a1416e7d0dcd5fa595aec0e3565c5120d6
+  data.tar.gz: fa61b04203610784aeec19f541a6b9b34a0e66d3cb14712f6fb81686dcefe7c076d3c694f2d779082c8fa6ef2f2794891a7c71ebbbf14c6122d2d182be3ee741

data/README.md

@@ -1,6 +1,7 @@
 [![Code Climate](https://codeclimate.com/github/cdale77/act_blue_reporter/badges/gpa.svg)](https://codeclimate.com/github/cdale77/act_blue_reporter)
 [![Test Coverage](https://codeclimate.com/github/cdale77/act_blue_reporter/badges/coverage.svg)](https://codeclimate.com/github/cdale77/act_blue_reporter)
 [![Build Status](https://travis-ci.org/cdale77/act_blue_reporter.svg?branch=master)](https://travis-ci.org/cdale77/act_blue_reporter)
+[![Gem Version](https://badge.fury.io/rb/act_blue_reporter.svg)](http://badge.fury.io/rb/act_blue_reporter)
 
 # ActBlueReporter
 
@@ -29,14 +30,14 @@ Or install it yourself as:
 ## Usage
 
 Create a campaign object. The login and password are the same as you use for
-the web interface. The entity ID can be obtain from the web interface. It is
-usually visible in the url. 
+the web interface. The entity ID can be obtained from the web interface. It is
+usually visible in the url. All three arguments are required.
 
-    campaign = ActBlueReporter::Campaign.new(act_blue_login, 
-                                             act_blue_password, 
-                                             act_blue_entity_id)
+    campaign = ActBlueReporter::Campaign.new(act_blue_login: my_login, 
+                                             act_blue_password: my_password, 
+                                             act_blue_entity_id: my_id)
                                   
-You can use the campaign object to get data
+You can use the campaign object to get data.
   
     # returns a hash of campaign details. Useful for checking credentials.
     campaign.details
@@ -44,21 +45,23 @@ You can use the campaign object to get data
     # returns a hash of all the campaign's contributions. Use with care. 
     campaign.all_contributions
     
-    # returns the contributions in the last 24 hours
+    # returns the contributions in the previous day (24 hours)
     campaign.contributions_in_last_24_hours
     
     # returns contributions in a certain time range. Arguments must be
-    # ISO 8601 formatted strings. 
-    contributions_in_time_range(start_time, end_time)
+    # ISO 8601 formatted strings. Defaults to the previous 24 hours if no 
+    # arguments are supplied
+    campaign.contributions_in_time_range(start_time: "2014-10-10T14:00:00-07:00", 
+                                         end_time: "2014-10-12T14:00:00-07:00")
     
-One of the problems with ActBlue's API is the structure of the response is 
+The structure of the response from ActBlue is 
 different if there is one contribution, or more than one. In particular, 
-responses containing multiple contributions are nested on level more than 
+responses containing multiple contributions are nested one level more than 
 single contributions. This class abstracts that away and returns a predictable 
 structure. 
 
     payload = campaign.all_contributions
-    formatter = ActBlueReporter::ContributionReport.new(payload)
+    formatter = ActBlueReporter::ContributionReport.new(payload: my_payload)
     report = formatter.report
     
     # you can also get the count of contributions from the formatter object

data/lib/act_blue_reporter/campaign.rb

@@ -7,35 +7,36 @@ module ActBlueReporter
     # This class models a campaign or committee at ActBlue and provides
     # some basic functionality. ActBlue calls these "entities".
 
-    def initialize(act_blue_login, act_blue_password, act_blue_entity_id)
+    def initialize(act_blue_login:, act_blue_password:, act_blue_entity_id: )
       @auth = { username: act_blue_login, password: act_blue_password }
       @act_blue_entity_id = act_blue_entity_id
     end
 
     def details
       request_uri = "/entities/#{@act_blue_entity_id}"
-      response = make_request(request_uri, @auth)
+      response = make_request(request_uri: request_uri, authentication: @auth)
       response["entity"]
     end
 
     def all_contributions
       request_uri = "/contributions?destination=#{@act_blue_entity_id}"
-      response = make_request(request_uri, @auth)
+      response = make_request(request_uri: request_uri, authentication: @auth)
       response["contributions"]
     end
 
-    def contributions_in_time_range(start_time, end_time)
+    # Defaults to the last 24 hours if no arguments are supplied
+    def contributions_in_time_range(start_time: (Time.now.at_beginning_of_day - 24.hours).iso8601, 
+                                    end_time: Time.now.at_beginning_of_day.iso8601)
       request_uri = "/contributions?destination=#{@entity.to_s}&" +
                     "payment_timestamp=#{start_time.to_s}/" +
                     "#{end_time.to_s}"
-      response = make_request(request_uri, @auth)
+      response = make_request(request_uri: request_uri, authentication: @auth)
       response["contributions"]
     end
 
+    # Mostly for syntax and clarity
     def contributions_in_last_24_hrs
-      start_time = (Time.now.at_beginning_of_day - 24.hours).iso8601
-      end_time = Time.now.at_beginning_of_day.iso8601
-      contributions_in_time_range(start_time, end_time)
+      contributions_in_time_range()
     end
   end
 end

data/lib/act_blue_reporter/connect.rb

@@ -13,7 +13,7 @@ module ActBlueReporter
     HEADER = { "Accept" => "application/xml" }
 
     private
-      def make_request(request_uri, authentication)
+      def make_request(request_uri:, authentication:)
 
         response = request_wrapper(request_uri, authentication)
 

data/lib/act_blue_reporter/contribution_report.rb

@@ -7,7 +7,7 @@ module ActBlueReporter
 
     attr_reader :payload
 
-    def initialize(payload)
+    def initialize(payload:)
       @payload = payload
     end
 

data/lib/act_blue_reporter/version.rb

@@ -1,3 +1,3 @@
 module ActBlueReporter
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/campaign_spec.rb

@@ -2,8 +2,13 @@ require "spec_helper"
 
 describe ActBlueReporter::Campaign do
 
-  let!(:campaign) { ActBlueReporter::Campaign.new("", "", "") }
-  let!(:failing_campaign) { ActBlueReporter::Campaign.new("", "", "0") }
+  let!(:campaign) { ActBlueReporter::Campaign.new(act_blue_login: "", 
+                                                  act_blue_password: "", 
+                                                  act_blue_entity_id: "") }
+
+  let!(:failing_campaign) { ActBlueReporter::Campaign.new(act_blue_login: "", 
+                                                          act_blue_password: "", 
+                                                          act_blue_entity_id: 0) }
 
   describe '#initialize' do
     it 'should create an object' do
@@ -50,19 +55,21 @@ describe ActBlueReporter::Campaign do
       end_time = "2014-08-24T00:00:00-07:00"
       describe 'success' do
         it 'should return a Hash' do
-          expect(campaign.contributions_in_time_range(start_time, end_time)).to \
-          be_an_instance_of Hash
+          result = campaign.contributions_in_time_range(start_time: start_time, end_time: end_time)
+          expect(result).to be_an_instance_of Hash
         end
         it 'should return a response with the correct info' do
-          expect(campaign.contributions_in_time_range(start_time, end_time)["count"]).to \
-            eq "3"
+          result = campaign.contributions_in_time_range(start_time: start_time, end_time: end_time)
+          expect(result["count"]).to eq "3"
         end
       end
     end
     describe 'failure' do
+      tart_time = "2014-08-23T00:00:00-07:00"
+      end_time = "2014-08-24T00:00:00-07:00"
       it 'should raise an error' do
         expect do
-          failing_campaign.contributions_in_time_range(start_time, end_time)
+          failing_campaign.contributions_in_time_range(start_time: start_time, end_time: end_time)
         end.to raise_error
       end
     end

data/spec/contribution_report_spec.rb

@@ -2,9 +2,11 @@ require "spec_helper"
 
 describe ActBlueReporter::ContributionReport do
 
-  let!(:campaign) { ActBlueReporter::Campaign.new("", "", "") }
+  let!(:campaign) { ActBlueReporter::Campaign.new(act_blue_login: "", 
+                                                  act_blue_password: "", 
+                                                  act_blue_entity_id: "") }
   let!(:payload) { campaign.contributions_in_last_24_hrs }
-  let!(:report) { ActBlueReporter::ContributionReport.new(payload) }
+  let!(:report) { ActBlueReporter::ContributionReport.new(payload: payload) }
 
   describe '#initialize' do
     it 'should create an object' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act_blue_reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Brad Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-20 00:00:00.000000000 Z
+date: 2014-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler