action_network_rest 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 793d30b8a56dd783ca9ab1d6672cd3aca17b78c5c7a8facc020b7d34b42e7f2d
-  data.tar.gz: f1b7ce262dda6c0df2a7c2a3a39646c87df67f58f74513c897fb6b19667d240e
+  metadata.gz: cc85d83854d521199b82e855ee4369c66c076a8487753756cc454010a0a22907
+  data.tar.gz: 684db90a396a39ebbdc54ffec3fcdba678a2338fbc334052786f7422d4990eb9
 SHA512:
-  metadata.gz: 80b85897ae76b566d3bc88668fb7f0d1176dd17450201dea32810a27affe44cef0001044a0ca9f55dff4d1a9a9a477bda8236ffe19158790b4be25a41791d4b1
-  data.tar.gz: d0d95da5ea4d06590ce2ac73105276f752748c16e536da7938cf3464bd3521445cb8abdb696cd67d9d1182b3569024342834721f8ea9c7dfdca137f9adc92e1a
+  metadata.gz: fa5f2ece5e76ef8bfbffd96349eb0c545c423da441a318fab71458d86f7ebfd483a4bc7f512f25df73ad9a5f1acfc32a1f60e1acb69770f5b0c75b8b695420ec
+  data.tar.gz: '0897288683f87fc8a9a273d360bf01bbbcf0da24bf7d90ffbb1176299a79f376a01d55e57af7a7680a771c8787579f78353eb5d32a08b0691d131b76f4431b45'

data/README.md

@@ -23,13 +23,46 @@ Or install it yourself as:
 ```
 client = ActionNetworkRest.new(api_key: YOUR_API_KEY)
 
-# Retrieve a Person's data
-person = client.people.get(person_actionnetwork_identifier)
-puts person.email_addresses
+# Check that our API key is working. Returns true or false.
+client.entry_point.authenticated_successfully?
+
+# See information about Action Network API endpoints
+client.entry_point.get
 
 # Create a new Person
 person = client.people.create(email_addresses: [{address: 'foo@example.com'}])
-puts person.identifiers
+person_id = person.action_network_id
+
+# Retrieve a Person's data
+person = client.people.get(person_id)
+puts person.email_addresses
+
+# Unsubscribe a Person
+client.people.unsubscribe(person_id)
+
+# Create a new Petition
+petition = client.petitions.create({title: 'Do the Thing!'}, creator_person_id: person_id)
+petition_id = petition.action_network_id
+
+# Retrieve a Petition
+petition = client.petitions.get(petition_id)
+puts petition.title
+
+# Update a Petition
+client.petitions.update(petition_id, {description: 'An updated description'})
+
+# Create a Signature on a Petition
+signature = client.petitions(petition_id).signatures.create({comments: 'This is so important',
+                                                             person: {email_addresses: [{address: 'alice@example.com'}]}},
+                                                            tags: ['volunteer'])
+signature_id = signature.action_network_id
+
+# Retrieve a Signature
+signature = client.petitions(petition_id).signatures.get(signature_id)
+puts signature.created_date
+
+# Update a Signature
+client.petitions(petition_id).signatures.update(signature_id, {comments: 'new comments'})
 ```
 
 ## Development

data/lib/action_network_rest.rb

@@ -12,5 +12,9 @@ end
 
 require "action_network_rest/version"
 require "action_network_rest/client"
+require 'action_network_rest/base'
 
+require 'action_network_rest/entry_point'
 require 'action_network_rest/people'
+require 'action_network_rest/petitions'
+require 'action_network_rest/signatures'

data/lib/action_network_rest/base.rb

@@ -0,0 +1,42 @@
+module ActionNetworkRest
+  class Base < Vertebrae::Model
+    def get(id)
+      response = client.get_request "#{base_path}#{url_escape(id)}"
+      object_from_response(response)
+    end
+
+    private
+
+    def url_escape(string)
+      CGI.escape(string.to_s)
+    end
+
+    def object_from_response(response)
+      obj = response.body
+
+      # The response we get from Action Network may contain an "identifiers" block that looks something like:
+      #
+      # "identifiers": [
+      #   "action_network:d6bdf50e-c3a4-4981-a948-3d8c086066d7",
+      #   "some_external_system:1",
+      #   "another_external_system:57"
+      # ]
+      #
+      # 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.
+      identifiers = obj[:identifiers] || []
+      qualified_actionnetwork_id = identifiers.find do |id|
+        id.split(':').first == 'action_network'
+      end
+      if qualified_actionnetwork_id.present?
+        obj.action_network_id = qualified_actionnetwork_id.sub(/^action_network:/, '')
+      end
+
+      obj
+    end
+
+    def action_network_url(path)
+      client.connection.configuration.endpoint + path
+    end
+  end
+end

data/lib/action_network_rest/client.rb

@@ -23,8 +23,16 @@ module ActionNetworkRest
 
     ## Helpers to let users do things like `an_client.people.create(params)`
 
+    def entry_point
+      @_entry_point ||= ActionNetworkRest::EntryPoint.new(client: self)
+    end
+
     def people
       @_people ||= ActionNetworkRest::People.new(client: self)
     end
+
+    def petitions(petition_id=nil)
+      @_petitions ||= ActionNetworkRest::Petitions.new(petition_id, client: self)
+    end
   end
 end

data/lib/action_network_rest/entry_point.rb

@@ -0,0 +1,21 @@
+module ActionNetworkRest
+  class EntryPoint < Vertebrae::Model
+    def base_path
+      ''
+    end
+
+    def get
+      response = client.get_request base_path
+      response.body
+    end
+
+    def authenticated_successfully?
+      response_body = get
+
+      # If we successfully authenticated, the entrypoint response will include a reference to tags.
+      # If not (API key missing or wrong), the response will not include anything about tags,
+      # but will otherwise be successful.
+      response_body.dig('_links', 'osdi:tags').present?
+    end
+  end
+end

data/lib/action_network_rest/people.rb

@@ -1,14 +1,9 @@
 module ActionNetworkRest
-  class People < Vertebrae::Model
+  class People < Base
     def base_path
       'people/'
     end
 
-    def get(id)
-      response = client.get_request "#{base_path}#{url_escape(id)}"
-      response.body
-    end
-
     def create(person_data, tags: [])
       post_body = {'person' => person_data}
       if tags.any?
@@ -16,13 +11,13 @@ module ActionNetworkRest
       end
 
       response = client.post_request base_path, post_body
-      response.body
+      object_from_response(response)
     end
 
-    private
-
-    def url_escape(string)
-      CGI.escape(string.to_s)
+    def unsubscribe(id)
+      request_body = {email_addresses: [{status: 'unsubscribed'}]}
+      response = client.put_request "#{base_path}#{url_escape(id)}", request_body
+      object_from_response(response)
     end
   end
 end

data/lib/action_network_rest/petitions.rb

@@ -0,0 +1,37 @@
+module ActionNetworkRest
+  class Petitions < Base
+    attr_accessor :petition_id
+
+    # Without a petition_id, this class is used for Petition creation/update endpoints.
+    # With a petition_id, this class is used to initialise the Signatures class,
+    # like client.petitions(123).signatures
+    def initialize(petition_id=nil, client:)
+      super(client: client, petition_id: petition_id)
+    end
+
+    def signatures
+      @_signatures ||= ActionNetworkRest::Signatures.new(client: client, petition_id: petition_id)
+    end
+
+    def base_path
+      'petitions/'
+    end
+
+    def create(petition_data, creator_person_id: nil)
+      post_body = petition_data
+      if creator_person_id.present?
+        creator_person_url = action_network_url("/people/#{url_escape(creator_person_id)}")
+        post_body['_links'] = {'osdi:creator' => {href: creator_person_url}}
+      end
+
+      response = client.post_request base_path, post_body
+      object_from_response(response)
+    end
+
+    def update(id, petition_data)
+      petition_path = "#{base_path}#{url_escape(id)}"
+      response = client.put_request petition_path, petition_data
+      object_from_response(response)
+    end
+  end
+end

data/lib/action_network_rest/signatures.rb

@@ -0,0 +1,29 @@
+module ActionNetworkRest
+  class Signatures < Base
+    attr_accessor :petition_id
+
+    def base_path
+      "petitions/#{url_escape(petition_id)}/signatures/"
+    end
+
+    def get(id)
+      response = client.get_request "#{base_path}#{url_escape(id)}"
+      object_from_response(response)
+    end
+
+    def create(signature_data, tags: [])
+      post_body = signature_data
+      if tags.any?
+        post_body['add_tags'] = tags
+      end
+
+      response = client.post_request base_path, post_body
+      object_from_response(response)
+    end
+
+    def update(id, signature_data)
+      response = client.put_request "#{base_path}#{url_escape(id)}", signature_data
+      object_from_response(response)
+    end
+  end
+end

data/lib/action_network_rest/version.rb

@@ -1,3 +1,3 @@
 module ActionNetworkRest
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_network_rest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Grey Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -93,13 +93,16 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - action_network_rest.gemspec
 - lib/action_network_rest.rb
+- lib/action_network_rest/base.rb
 - lib/action_network_rest/client.rb
+- lib/action_network_rest/entry_point.rb
 - lib/action_network_rest/people.rb
+- lib/action_network_rest/petitions.rb
+- lib/action_network_rest/signatures.rb
 - lib/action_network_rest/version.rb
 homepage: https://github.com/controlshift/action-network-rest
 licenses:

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Grey Moore
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.