action_network_rest 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc85d83854d521199b82e855ee4369c66c076a8487753756cc454010a0a22907
+  data.tar.gz: 684db90a396a39ebbdc54ffec3fcdba678a2338fbc334052786f7422d4990eb9
+SHA512:
+  metadata.gz: fa5f2ece5e76ef8bfbffd96349eb0c545c423da441a318fab71458d86f7ebfd483a4bc7f512f25df73ad9a5f1acfc32a1f60e1acb69770f5b0c75b8b695420ec
+  data.tar.gz: '0897288683f87fc8a9a273d360bf01bbbcf0da24bf7d90ffbb1176299a79f376a01d55e57af7a7680a771c8787579f78353eb5d32a08b0691d131b76f4431b45'

data/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+.rspec_status

data/.ruby-gemset

@@ -0,0 +1 @@
+action-network-rest

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at talk@controlshiftlabs.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in action_network_rest.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ControlShift
+
+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.

data/README.md

@@ -0,0 +1,84 @@
+# ActionNetworkRest
+
+Ruby client for interacting with the [ActionNetwork REST API](https://actionnetwork.org/docs/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_network_rest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_network_rest
+
+## Usage
+
+```
+client = ActionNetworkRest.new(api_key: YOUR_API_KEY)
+
+# 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'}])
+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
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/controlshift/action-network-rest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActionNetworkRest project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/controlshift/action-network-rest/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/action_network_rest.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "action_network_rest/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_network_rest"
+  spec.version       = ActionNetworkRest::VERSION
+  spec.authors       = ["Grey Moore"]
+  spec.email         = ["grey@controlshiftlabs.com"]
+
+  spec.summary       = "Ruby client for interacting with the ActionNetwork REST API"
+  spec.homepage      = "https://github.com/controlshift/action-network-rest"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "vertebrae", "~> 0.6.0"
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'webmock', '~> 3.8.3'
+end

data/lib/action_network_rest.rb

@@ -0,0 +1,20 @@
+require 'vertebrae'
+
+module ActionNetworkRest
+  extend Vertebrae::Base
+
+  class << self
+    def new(options = {})
+      ActionNetworkRest::Client.new(options)
+    end
+  end
+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

@@ -0,0 +1,38 @@
+module ActionNetworkRest
+  class Client < Vertebrae::API
+    attr_accessor :api_key
+
+    def initialize(options={}, &block)
+      self.api_key = options[:api_key]
+      super(options={}, &block)
+    end
+
+    def default_options
+      {
+        host: 'actionnetwork.org',
+        prefix: '/api/v2',
+        content_type: 'application/json',
+        additional_headers: {'OSDI-API-Token' => api_key},
+        user_agent: 'ruby: ActionNetworkRest'
+      }
+    end
+
+    def extract_data_from_params(params)
+      params.to_json
+    end
+
+    ## 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

@@ -0,0 +1,23 @@
+module ActionNetworkRest
+  class People < Base
+    def base_path
+      'people/'
+    end
+
+    def create(person_data, tags: [])
+      post_body = {'person' => person_data}
+      if tags.any?
+        post_body['add_tags'] = tags
+      end
+
+      response = client.post_request base_path, post_body
+      object_from_response(response)
+    end
+
+    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

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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: action_network_rest
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Grey Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-29 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+description: 
+email:
+- grey@controlshiftlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- 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:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for interacting with the ActionNetwork REST API
+test_files: []