action_network_rest 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ac436fdf54dc3a69ce38d4a38cb2f3b40db35083d20a5817db63e4546da610
-  data.tar.gz: a61e130172cf21c309000c632b6b57230c5d88fb18213c0c3c5961cc697e74de
+  metadata.gz: abb5c663b923a0f30bfcaf0b70fd43de40baf9f59752154eaead286acf7259a7
+  data.tar.gz: dbd808c9166b1047c70d87df247a5d624851f1e69a4271da6edb70ca578a9161
 SHA512:
-  metadata.gz: 3a5bd5ea4d0f915429a85f7c01380642c0a390bf2d011cfa507b01f094572deab777184b2d11e58ba7cc118253cd9e042e0c005936e9255cfb7fade3bbe6019b
-  data.tar.gz: 1f73b9a22ca1cc3328331435cdcdcc25dfffe8d1dc85e053dd0a79df14f36343374dfc4daeac812c3949bb6c2f10998487ada99df81d16e349fb39cb2f6a6c98
+  metadata.gz: 71b0865b95a6d0ac618f6d9a35379b9998391c05dee7714c5b12dc0c8215e2ade7163cd8d2e81b3bd1a5d4743d6599207c22d48b22a7a5f9e724ccbc99ebe907
+  data.tar.gz: afac667e373e1ce51641edd1cde82d4269220ef95b847cc589fd9ffa079419e559f42c677210a87a91888e978a40ac07c5199179e684923f2feebc8c032849a8

data/README.md

@@ -35,6 +35,17 @@ client.entry_point.get
 person = client.people.create(email_addresses: [{address: 'foo@example.com'}])
 person_id = person.action_network_id
 
+# List people
+people = client.people.list
+
+# Iterate over a list of people
+page_number = 1
+loop do
+  people = client.people.list(page: page_number)
+  break if people.empty?
+  page_number += 1
+end
+
 # Retrieve a Person's data
 person = client.people.get(person_id)
 puts person.email_addresses
@@ -78,6 +89,9 @@ tag_id = tag.action_network_id
 # Retrieve a Tag
 tag = client.tags.get(tag_id)
 
+# Retrieve a Tag by name
+tag = client.tags.find_by_name('Volunteers')
+
 # Apply a Tag to a Person
 tagging = client.tags(tag_id).create({identifiers: ['external:123']}, person_id: person_id)
 tagging_id = tagging.action_network_id

data/lib/action_network_rest/base.rb

@@ -5,13 +5,23 @@ module ActionNetworkRest
       object_from_response(response)
     end
 
+    def list(page: 1)
+      response = client.get_request "#{base_path}?page=#{page}"
+      objects = response.body.dig('_embedded', osdi_key)
+      return [] if objects.nil?
+
+      objects.each { |obj| set_action_network_id_on_object(obj) }
+
+      objects
+    end
+
     private
 
     def url_escape(string)
       CGI.escape(string.to_s)
     end
 
-    def object_with_action_network_id(obj)
+    def set_action_network_id_on_object(obj)
       # 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.
@@ -33,7 +43,7 @@ module ActionNetworkRest
 
     def object_from_response(response)
       obj = response.body
-      object_with_action_network_id(obj)
+      set_action_network_id_on_object(obj)
     end
 
     def action_network_url(path)

data/lib/action_network_rest/people.rb

@@ -35,10 +35,16 @@ module ActionNetworkRest
       #
       url_encoded_filter_string = url_escape("email_address eq '#{email}'")
       response = client.get_request "#{base_path}?filter=#{url_encoded_filter_string}"
-      person_object = response.body[:_embedded]['osdi:people'].first
+      person_object = response.body[:_embedded][osdi_key].first
       if person_object.present?
-        object_with_action_network_id(person_object)
+        set_action_network_id_on_object(person_object)
       end
     end
+
+    private
+
+    def osdi_key
+      'osdi:people'
+    end
   end
 end

data/lib/action_network_rest/petitions.rb

@@ -33,5 +33,11 @@ module ActionNetworkRest
       response = client.put_request petition_path, petition_data
       object_from_response(response)
     end
+
+    private
+
+    def osdi_key
+      'osdi:petitions'
+    end
   end
 end

data/lib/action_network_rest/signatures.rb

@@ -20,5 +20,11 @@ module ActionNetworkRest
       response = client.put_request "#{base_path}#{url_escape(id)}", signature_data
       object_from_response(response)
     end
+
+    private
+
+    def osdi_key
+      'osdi:signatures'
+    end
   end
 end

data/lib/action_network_rest/taggings.rb

@@ -19,5 +19,11 @@ module ActionNetworkRest
       response = client.delete_request "#{base_path}#{url_escape(id)}"
       object_from_response(response)
     end
+
+    private
+
+    def osdi_key
+      'osdi:taggings'
+    end
   end
 end

data/lib/action_network_rest/tags.rb

@@ -22,5 +22,27 @@ module ActionNetworkRest
       response = client.post_request base_path, post_body
       object_from_response(response)
     end
+
+    def find_by_name(name)
+      # Action Network API doesn't support currently OData querying for tags
+      # (https://actionnetwork.org/docs/v2#odata) so we need to retrieve a list of
+      # all tags and iterate to find the one we're looking for.
+      page = 1
+      loop do
+        tags = self.list(page: page)
+        return nil if tags.empty?
+
+        found_tag = tags.find { |t| t.name == name }
+        return found_tag unless found_tag.nil?
+
+        page += 1
+      end
+    end
+
+    private
+
+    def osdi_key
+      'osdi:tags'
+    end
   end
 end

data/lib/action_network_rest/version.rb

@@ -1,3 +1,3 @@
 module ActionNetworkRest
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_network_rest
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Grey Moore
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby client for interacting with the ActionNetwork REST API