act_blue_reporter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03bdbd7f49fc11b96a8ffbdf59f75c9b277a0f76
-  data.tar.gz: 57608ae1fb9e8429d9a0746daea595aafd923d1f
+  metadata.gz: d1fb11f172ddbec69ae35cab10d2f44848e544fa
+  data.tar.gz: e92c05017f1b82855d821668cb436feff3c2904a
 SHA512:
-  metadata.gz: e07ff66199a5e10f5524c3c1deac8b8b09ed88633010ffbd811e6d29f499a66fb1c40b88248a3ba53db501553cc6862f43dca84f6b2cb75e0b7f83ddeea429a2
-  data.tar.gz: 08ea144d231393c60194bf1bf899b709a0bf3e86962da16f143dd588576dc6124e36610980924d97797e39f12b4c840c5603fe80e6c9cd079f51861265bd15d9
+  metadata.gz: 494af4ada1b134c599b22d804c54988b6e6c08e83086b21e80c100f103b5108d9308b133c093c543707dad57b3d4bd4e161de96656d39e7b7898b5c7c56b8791
+  data.tar.gz: ba62c8910f40feb734bfe9538b0be23ee82359be32575349a0c4298f4e21f0e231607fb33faec8e8b2dd852cc71106e221ea79e07ee2245ea3de8bbb168e1d47

data/README.md

@@ -10,6 +10,8 @@ ActBlue. It is designed to work across multiple ActBlue campaigns.
 It is not a full-fledged wrapper for the ActBlue API; it doesn't do much more
 than retrieve data. 
 
+Extracted from [DonorStack](http://donorstack.com/).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,7 +28,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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. 
+
+    campaign = ActBlueReporter::Campaign.new(act_blue_login, 
+                                             act_blue_password, 
+                                             act_blue_entity_id)
+                                  
+You can use the campaign object to get data
+  
+    # returns a hash of campaign details. Useful for checking credentials.
+    campaign.details
+    
+    # returns a hash of all the campaign's contributions. Use with care. 
+    campaign.all_contributions
+    
+    # returns the contributions in the last 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)
+    
+One of the problems with ActBlue's API is the structure of the response is 
+different if there is one contribution, or more than one. In particular, 
+responses containing multiple contributions are nested on level more than 
+single contributions. This class abstracts that away and returns a predictable 
+structure. 
+
+    payload = campaign.all_contributions
+    formatter = ActBlueReporter::ContributionReport.new(payload)
+    report = formatter.report
+    
+    # you can also get the count of contributions from the formatter object
+    formatter.count
+    
 
 ## Contributing
 

data/act_blue_reporter.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "pry-remote", "~> 0.1"
   spec.add_development_dependency "pry-nav", "~> 0.2"

data/lib/act_blue_reporter/campaign.rb

@@ -15,35 +15,27 @@ module ActBlueReporter
     def details
       request_uri = "/entities/#{@act_blue_entity_id}"
       response = make_request(request_uri, @auth)
-      payload = response["entity"]
-      raise ActBlueReporter::Exceptions::PayloadError unless payload
-      return payload
+      response["entity"]
     end
 
     def all_contributions
       request_uri = "/contributions?destination=#{@act_blue_entity_id}"
       response = make_request(request_uri, @auth)
-      payload = response["contributions"]
-      raise ActBlueReporter::Exceptions::PayloadError unless payload
-      return payload
+      response["contributions"]
     end
 
     def contributions_in_time_range(start_time, end_time)
-      response = make_request( "/contributions?destination=#{@entity.to_s}&" \
-                              "payment_timestamp=#{start_time.to_s}/" \
-                              "#{end_time.to_s}",
-                               @auth)
-      payload = response["contributions"]
-      raise ActBlueReporter::Exceptions::PayloadError unless payload
-      return payload
+      request_uri = "/contributions?destination=#{@entity.to_s}&" +
+                    "payment_timestamp=#{start_time.to_s}/" +
+                    "#{end_time.to_s}"
+      response = make_request(request_uri, @auth)
+      response["contributions"]
     end
 
     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
-      payload = contributions_in_time_range(start_time, end_time)
-      raise ActBlueReporter::Exceptions::PayloadError unless payload
-      return payload
+      contributions_in_time_range(start_time, end_time)
     end
   end
 end

data/lib/act_blue_reporter/connect.rb

@@ -47,6 +47,11 @@ module ActBlueReporter
         unless response.success?
           raise_error("HTTP response code: #{response.response.code}")
         end
+
+        # raise an error if the response is not a hash
+        unless response.is_a? Hash
+          raise_error("Response is a #{response.class}. Expecting hash")
+        end
       end
 
 

data/lib/act_blue_reporter/exceptions.rb

@@ -6,11 +6,5 @@ module ActBlueReporter
         super
       end
     end
-
-    class PayloadError < StandardError
-      def initialize(msg = "Did not receive the requested data from ActBlue")
-        super
-      end
-    end
   end
 end

data/lib/act_blue_reporter/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: act_blue_reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brad Johnson
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement