action_network_rest 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c51a40b6924bf886e768ec83816bbe33d0a9cbd006c995631d5ddf1248b677
-  data.tar.gz: 0a4506ccdd24760312a0149f4d5e363d99c4a27d21a6b11537ce059f3c637830
+  metadata.gz: 4dd1262504cea7929b18b241d18a1559bae11daa1f48cbc3d460726e5e71d091
+  data.tar.gz: 413a0c44954cb1e8163a880196f3ef9e05d42fad5d9ddcb3685b55ef6c35426c
 SHA512:
-  metadata.gz: e52d89573de10a3963b5f14da3269beb6568a3090bf975c419c6f641a62f090277ec3fcc4d9c22be13f3160ab4d2be7f256b106379339ce8e16f4c8c06b109b4
-  data.tar.gz: 366ab08d1f91e871414a6b721ca846ab17ecaf87e2ed6c344d144bd8e9004cc6574af5dcdfc95b217aec7a0d17cb02cc50f4d01cc3b86d76e3bd09dc1c2e16cb
+  metadata.gz: 34765ac6ce7ace26653131e30d6ddb89cafd8f0757206fb224f82d408e87ba2f960c81a0e90fabc0aaea1fa7d5035a253f83e8587e83b3884a8de8ccd4bededc
+  data.tar.gz: 0d229ac881b630f9caa45b2219ff4dc3bb5248f3d57a3b3ae6e975a8758c29be8fec293ee2e6e3e4f93ec7d0717765744a22fe0f51593659e41588b27a333b77

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.2.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
@@ -57,6 +60,11 @@ person = client.people.find_by_email(person_email)
 person_id = person.action_network_id
 puts person.email_addresses
 
+# Retrieve a Person's data by their phone_number
+person = client.people.find_by_phone_number('+12223334444')
+person_id = person.action_network_id
+puts person.phone_numbers
+
 # Update a Person
 client.people.update(person_id, {custom_fields: {custom_id: "12345"}})
 
@@ -114,6 +122,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

@@ -23,14 +23,15 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6'
 
-  spec.add_runtime_dependency 'vertebrae', '~> 0.6.0'
+  spec.add_runtime_dependency 'vertebrae', '< 1'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'byebug', '~> 11.1'
+  spec.add_development_dependency 'debug', '> 0'
   spec.add_development_dependency 'dotenv', '~> 2.7'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop', '> 0'
+  spec.add_development_dependency 'rubocop-performance', '> 0'
   spec.add_development_dependency 'webmock', '~> 3.8.3'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/bin/rake

@@ -15,7 +15,7 @@ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
 bundle_binstub = File.expand_path('bundle', __dir__)
 
 if File.file?(bundle_binstub)
-  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/rspec

@@ -15,7 +15,7 @@ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
 bundle_binstub = File.expand_path('bundle', __dir__)
 
 if File.file?(bundle_binstub)
-  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

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,6 +17,49 @@ 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 exceed 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 response
+          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)

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/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/people.rb

@@ -39,6 +39,25 @@ module ActionNetworkRest
       set_action_network_id_on_object(person_object) if person_object.present?
     end
 
+    def find_by_phone_number(phone_number)
+      # This works for parsing exactly 1 person's info out of the response.
+      # The response we get from Action Network is expected to have
+      #
+      # "_embedded": {
+      #   "osdi:people": [{
+      #       "identifiers": [
+      #           "action_network:c947bcd0-929e-11e3-a2e9-12313d316c29"
+      #            ....
+      #        ]
+      #    }]
+      # }
+      #
+      url_encoded_filter_string = url_escape("phone_number eq '#{phone_number}'")
+      response = client.get_request "#{base_path}?filter=#{url_encoded_filter_string}"
+      person_object = response.body[:_embedded][osdi_key].first
+      set_action_network_id_on_object(person_object) if person_object.present?
+    end
+
     def update(id, person_data)
       people_path = "#{base_path}#{url_escape(id)}"
       response = client.put_request people_path, person_data

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
@@ -36,5 +38,9 @@ module ActionNetworkRest
     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.10.0'
+  VERSION = '0.12.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,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: action_network_rest
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Grey Moore
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2023-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -98,28 +98,28 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -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