action_network_rest 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9016ae9e2c22b78c042639d589683ff591c4098712cad0861dc8faab843c82a
-  data.tar.gz: 114f680aead1e7b3500c26fb61175784046bf68db57ac62137df455f98f1789e
+  metadata.gz: 60ec6a3895471c7d3a0f2a45076fc79e085a215ab5615be1db0f665ad6503106
+  data.tar.gz: 940276b2e72e63794de66a46d06c549126a446de28f79dc8a8ba5440fd7d4657
 SHA512:
-  metadata.gz: 7f811528d9ffe857652121e3c3bf42b517b9991a5335dd52fd99c02d36b3a75688bbc403c16aca0cdd619a4efc96fc3d5f50cb7d4fcddc2b01731c068c85e03b
-  data.tar.gz: b4db252bd30f7aeee2f3d402f287104212e51a7cf2e745773767d63f577a9d1c9131b4162b671b0568108b1b7d6e7e23434ed5d1016c949eb5e613238722c5fb
+  metadata.gz: 13a5c4e166e1d6a83c637a7ff70ef0bec3e105d647bf484fd35bd296b11787812fcf6cb7a2d73ad55a60aea7adba1ebb3083170208db3c8132aa94890982f5ba
+  data.tar.gz: 6436d185b7311fd1dae2c9663f178886a0d1cc9ab5a5fcf956ff001acc1154e5e8ecc0cf978dc441470effc00ce4c01bb919185929036a7dcf7fc93aba041fce

data/.github/workflows/ci.yml

@@ -6,9 +6,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.1
           bundler-cache: true
       - run: bundle install
       - run: bundle exec rspec
@@ -16,9 +16,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.1
           bundler-cache: true
       - run: bundle install
       - run: bundle exec rubocop

data/.ruby-version

@@ -1 +1 @@
-2.7.4
+3.1.2

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-```
+```ruby
 require 'action_network_rest'
 
 client = ActionNetworkRest.new(api_key: YOUR_API_KEY)
@@ -40,6 +40,9 @@ person_id = person.action_network_id
 # List people
 people = client.people.list
 
+# List all people
+people = client.people.all
+
 # Iterate over a list of people
 page_number = 1
 loop do
@@ -114,6 +117,38 @@ client.event_campaigns(event_campaign_id).events.list
 # Add an Attendance
 event_id = '123e4567-e89b-12d3-a456-426655440000'
 client.events(event_id).attendances.create({ person: {email_addresses: [{address: 'alice@example.com'}]}})
+
+# Get, list, or list all campaigns
+client.campaigns.get('123e4567-e89b-12d3-a456-426614174000')
+client.campaigns.list
+client.campaigns.all
+
+# Get, list, list all, create or update Advocacy Campaigns
+client.advocacy_campaigns.list
+client.advocacy_campaigns.all
+client.advocacy_campaigns.create({	
+  title: "My Free Advocacy Campaign",
+  origin_system: "FreeAdvocacy.com",
+  type: "email"
+})
+client.advocacy_campaigns.get('123e4567-e89b-12d3-a456-426614174000')
+client.advocacy_campaigns.update('123e4567-e89b-12d3-a456-426614174000', {	
+  title: "My Free Advocacy Campaign With A New Name",
+  description: "This is my free advocacy campaign description"
+})
+
+# Get, list, list all, create or update formss
+client.form.list
+client.form.all
+client.form.create({	
+  title: "My Free Form",
+  origin_system: "FreeForm.com"
+})
+client.form.get('123e4567-e89b-12d3-a456-426614174000')
+client.form.update('123e4567-e89b-12d3-a456-426614174000', {	
+  title: "My Free Form With A New Name",
+  description: "This is my free form description"
+})
 ```
 
 ## Development

data/action_network_rest.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'webmock', '~> 3.8.3'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/example.rb

@@ -7,7 +7,7 @@ require 'byebug'
 Dotenv.load('.env')
 raise 'Must set API_KEY environmental variable. See .env.sample for details' if ENV['API_KEY'].nil?
 
-client = ActionNetworkRest.new(api_key: ENV['API_KEY']) # rubocop:disable Lint/UselessAssignment
+client = ActionNetworkRest.new(api_key: ENV.fetch('API_KEY')) # rubocop:disable Lint/UselessAssignment
 
 puts "Ready to call Action Network API using 'client' object"
 byebug # rubocop:disable Lint/Debugger

data/lib/action_network_rest/advocacy_campaigns.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ActionNetworkRest
+  class AdvocacyCampaigns < Base
+    def initialize(client:)
+      super(client: client)
+    end
+
+    def base_path
+      'advocacy_campaigns/'
+    end
+
+    def create(advocacy_campaign_data)
+      post_body = advocacy_campaign_data
+      puts base_path
+      response = client.post_request(base_path, post_body)
+      object_from_response(response, action_network_id_required: true)
+    end
+
+    def update(advocacy_campaign_id, advocacy_campaign_data)
+      put_body = advocacy_campaign_data
+
+      response = client.put_request("#{base_path}#{advocacy_campaign_id}", put_body)
+      object_from_response(response, action_network_id_required: true)
+    end
+
+    private
+
+    def osdi_key
+      'osdi:advocacy_campaigns'
+    end
+  end
+end

data/lib/action_network_rest/base.rb

@@ -17,13 +17,56 @@ module ActionNetworkRest
       objects
     end
 
+    def all
+      min_wait = 0.25 # sec to wait between calls
+      timestamp = Time.now.to_r # secs since Unix Epoch
+      page_number = 1
+      tries = 0
+      all = []
+      loop do
+        # Limit rate before request to avoid error
+        wait = min_wait * (1.5**tries)
+        new_time = Time.now.to_r
+        if (timestamp + min_wait - new_time).positive?
+          sleep(wait) # Wait if calling again could excede the rate limit
+          tries += 1
+          next # check again
+        end
+
+        begin
+          page = list(page: page_number)
+        rescue ActionNetworkRest::Response::TooManyRequests
+          if tries >= 10
+            raise ActionNetworkRest::Response::UsedAllRequestTries,
+                  {
+                    tries: tries,
+                    last_wait_length: wait,
+                    resource: base_path
+                  }.to_json
+          end
+
+          sleep(wait)
+          tries += 1 # Exponential back off if got Too Many Requests error reponse
+          next
+        end
+        timestamp = Time.now.to_r
+
+        break if page.empty?
+
+        all.concat(page)
+        page_number += 1
+        tries = 0
+      end
+      all
+    end
+
     private
 
     def url_escape(string)
       CGI.escape(string.to_s)
     end
 
-    def set_action_network_id_on_object(obj)
+    def set_action_network_id_on_object(obj, action_network_id_required: false)
       # Takes an object which may contain an `identifiers` key, which may contain an action_network identifier
       # If so, we pull out the action_network identifier and stick it in a top-level key "action_network_id",
       # for the convenience of callers using the returned object.
@@ -38,14 +81,16 @@ module ActionNetworkRest
       end
       if qualified_actionnetwork_id.present?
         obj.action_network_id = qualified_actionnetwork_id.sub(/^action_network:/, '')
+      elsif action_network_id_required
+        raise ActionNetworkRest::Response::MissingActionNetworkId, obj.inspect
       end
 
       obj
     end
 
-    def object_from_response(response)
+    def object_from_response(response, action_network_id_required: false)
       obj = response.body
-      set_action_network_id_on_object(obj)
+      set_action_network_id_on_object(obj, action_network_id_required: action_network_id_required)
     end
 
     def action_network_url(path)

data/lib/action_network_rest/campaigns.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActionNetworkRest
+  class Campaigns < Base
+    attr_accessor :campaign_id
+
+    def initialize(client:)
+      super(client: client)
+    end
+
+    def base_path
+      'campaigns/'
+    end
+
+    private
+
+    def osdi_key
+      'action_network:campaigns'
+    end
+  end
+end

data/lib/action_network_rest/client.rb

@@ -25,6 +25,14 @@ module ActionNetworkRest
 
     ## Helpers to let users do things like `an_client.people.create(params)`
 
+    def advocacy_campaigns
+      @_advocacy_campaigns ||= ActionNetworkRest::AdvocacyCampaigns.new(client: self)
+    end
+
+    def campaigns
+      @_campaigns ||= ActionNetworkRest::Campaigns.new(client: self)
+    end
+
     def events(event_id = nil)
       if @_events&.send(:[], event_id).nil?
         @_events = {} if @_events.nil?
@@ -49,6 +57,10 @@ module ActionNetworkRest
       @_entry_point ||= ActionNetworkRest::EntryPoint.new(client: self)
     end
 
+    def forms
+      @_forms ||= ActionNetworkRest::Forms.new(client: self)
+    end
+
     def people
       @_people ||= ActionNetworkRest::People.new(client: self)
     end

data/lib/action_network_rest/events.rb

@@ -32,7 +32,7 @@ module ActionNetworkRest
       end
 
       response = client.post_request(base_path, post_body)
-      object_from_response(response)
+      object_from_response(response, action_network_id_required: true)
     end
 
     def attendances

data/lib/action_network_rest/forms.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ActionNetworkRest
+  class Forms < Base
+    def initialize(client:)
+      super(client: client)
+    end
+
+    def base_path
+      'forms/'
+    end
+
+    def create(form_data)
+      post_data = form_data
+
+      response = client.post_request(base_path, post_data)
+      object_from_response(response, action_network_id_required: true)
+    end
+
+    def update(form_id, form_data)
+      put_data = form_data
+
+      response = client.put_request("#{base_path}#{form_id}", put_data)
+      object_from_response(response, action_network_id_required: true)
+    end
+
+    private
+
+    def osdi_key
+      'osdi:forms'
+    end
+  end
+end

data/lib/action_network_rest/response/raise_error.rb

@@ -17,6 +17,8 @@ module ActionNetworkRest
             end
           elsif status_code == 404
             raise NotFoundError, error_message(response)
+          elsif status_code == 429
+            raise TooManyRequests, error_message(response)
           else
             raise ResponseError, error_message(response)
           end
@@ -29,10 +31,16 @@ module ActionNetworkRest
       end
     end
 
+    class MissingActionNetworkId < StandardError; end
+
     class MustSpecifyValidPersonId < StandardError; end
 
     class NotFoundError < StandardError; end
 
     class ResponseError < StandardError; end
+
+    class TooManyRequests < StandardError; end
+
+    class UsedAllRequestTries < StandardError; end
   end
 end

data/lib/action_network_rest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionNetworkRest
-  VERSION = '0.9.0'
+  VERSION = '0.11.0'
 end

data/lib/action_network_rest.rb

@@ -18,10 +18,13 @@ require 'action_network_rest/response/raise_error'
 require 'action_network_rest/client'
 require 'action_network_rest/base'
 
+require 'action_network_rest/advocacy_campaigns'
 require 'action_network_rest/attendances'
+require 'action_network_rest/campaigns'
 require 'action_network_rest/entry_point'
 require 'action_network_rest/events'
 require 'action_network_rest/event_campaigns'
+require 'action_network_rest/forms'
 require 'action_network_rest/people'
 require 'action_network_rest/petitions'
 require 'action_network_rest/signatures'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_network_rest
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Grey Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -160,13 +160,16 @@ files:
 - bin/rspec
 - example.rb
 - lib/action_network_rest.rb
+- lib/action_network_rest/advocacy_campaigns.rb
 - lib/action_network_rest/api.rb
 - lib/action_network_rest/attendances.rb
 - lib/action_network_rest/base.rb
+- lib/action_network_rest/campaigns.rb
 - lib/action_network_rest/client.rb
 - lib/action_network_rest/entry_point.rb
 - lib/action_network_rest/event_campaigns.rb
 - lib/action_network_rest/events.rb
+- lib/action_network_rest/forms.rb
 - lib/action_network_rest/people.rb
 - lib/action_network_rest/petitions.rb
 - lib/action_network_rest/response/raise_error.rb
@@ -177,7 +180,8 @@ files:
 homepage: https://github.com/controlshift/action-network-rest
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -193,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.19
 signing_key: 
 specification_version: 4
 summary: Ruby client for interacting with the ActionNetwork REST API