action_network_rest 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c7052276bcde7acbbc808912711dd160a2ec75b13905dac5cd11d25555deadd
-  data.tar.gz: acc6e54314b4671d2969fb91065185f249c073d6371999648d0016bcef868383
+  metadata.gz: a5ac436fdf54dc3a69ce38d4a38cb2f3b40db35083d20a5817db63e4546da610
+  data.tar.gz: a61e130172cf21c309000c632b6b57230c5d88fb18213c0c3c5961cc697e74de
 SHA512:
-  metadata.gz: 8065e41e4a565188ad1a2b6c24bb67c2858d4ea9d793b03082c4fd2cc0764ceba51f69df7481fa3e8ba6a961217cd3e769caa6c88fbcd90c286bbc9fdf5fef30
-  data.tar.gz: c4644fd81aba749b33a2871b4f776e182464c25f3be8f754d8d9209666aa98ea19ca1385d4fe977407a0e5e9ab0749224ee5211e2355891fba22d725e9635be2
+  metadata.gz: 3a5bd5ea4d0f915429a85f7c01380642c0a390bf2d011cfa507b01f094572deab777184b2d11e58ba7cc118253cd9e042e0c005936e9255cfb7fade3bbe6019b
+  data.tar.gz: 1f73b9a22ca1cc3328331435cdcdcc25dfffe8d1dc85e053dd0a79df14f36343374dfc4daeac812c3949bb6c2f10998487ada99df81d16e349fb39cb2f6a6c98

data/.env.sample

@@ -0,0 +1,2 @@
+# API key used on example.rb, you don't need to define this in the gem including code
+API_KEY=xyz

data/.gitignore

@@ -11,7 +11,7 @@
 /tmp/
 
 # Used by dotenv library to load environment variables.
-# .env
+.env
 
 # Ignore Byebug command history file.
 .byebug_history

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  DisabledByDefault: true
+
+Security:
+  Enabled: true
+
+Bundler/DuplicatedGem:
+  Enabled: true
+Bundler/InsecureProtocolSource:
+  Enabled: true
+Layout/IndentationStyle:
+  Enabled: true
+Layout/SpaceInsideRangeLiteral:
+  Enabled: true
+Lint:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Naming/AsciiIdentifiers:
+  Enabled: true
+Naming/ClassAndModuleCamelCase:
+  Enabled: true
+Naming/ConstantName:
+  Enabled: true
+Naming/FileName:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.6
+cache: bundler
+before_install:
+  - gem install bundler
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/README.md

@@ -1,6 +1,8 @@
 # ActionNetworkRest
 
-Ruby client for interacting with the [ActionNetwork REST API](https://actionnetwork.org/docs/)
+Ruby client for interacting with the [ActionNetwork REST API](https://actionnetwork.org/docs/) from the engineering team at [ControlShift](https://www.controlshiftlabs.com/).
+
+[![Build Status](https://travis-ci.org/controlshift/action-network-rest.svg?branch=master)](https://travis-ci.org/controlshift/action-network-rest)
 
 ## Installation
 
@@ -37,6 +39,11 @@ person_id = person.action_network_id
 person = client.people.get(person_id)
 puts person.email_addresses
 
+# Retrieve a Person's data by their email address
+person = client.people.find_by_email(person_email
+person_id = person.action_network_id
+puts person.email_addresses
+
 # Unsubscribe a Person
 client.people.unsubscribe(person_id)
 
@@ -88,6 +95,8 @@ After checking out the repo, run `bundle install` to install dependencies. Then,
 
 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).
 
+To run a REPL with an initialized client object you'll need to create your own `.env` file based off `.env.sample` and then run `bundle exec ruby example.rb`.
+
 ## 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.

data/action_network_rest.gemspec

@@ -23,7 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "vertebrae", "~> 0.6.0"
 
   spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "byebug", "~> 11.1"
+  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 'webmock', '~> 3.8.3'
+  spec.add_development_dependency 'rubocop'
 end

data/example.rb

@@ -0,0 +1,13 @@
+require_relative 'lib/action_network_rest'
+require 'dotenv'
+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
+
+puts "Ready to call Action Network API using 'client' object"
+byebug # rubocop:disable Lint/Debugger
+
+puts "Bye!"

data/lib/action_network_rest/base.rb

@@ -11,19 +11,15 @@ module ActionNetworkRest
       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:
-      #
+    def object_with_action_network_id(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.
       # "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'
@@ -35,6 +31,11 @@ module ActionNetworkRest
       obj
     end
 
+    def object_from_response(response)
+      obj = response.body
+      object_with_action_network_id(obj)
+    end
+
     def action_network_url(path)
       client.connection.configuration.endpoint + path
     end

data/lib/action_network_rest/client.rb

@@ -4,7 +4,7 @@ module ActionNetworkRest
 
     def initialize(options={}, &block)
       self.api_key = options[:api_key]
-      super(options={}, &block)
+      super(options, &block)
     end
 
     def default_options

data/lib/action_network_rest/people.rb

@@ -19,5 +19,26 @@ module ActionNetworkRest
       response = client.put_request "#{base_path}#{url_escape(id)}", request_body
       object_from_response(response)
     end
+
+    def find_by_email(email)
+      # 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("email_address eq '#{email}'")
+      response = client.get_request "#{base_path}?filter=#{url_encoded_filter_string}"
+      person_object = response.body[:_embedded]['osdi:people'].first
+      if person_object.present?
+        object_with_action_network_id(person_object)
+      end
+    end
   end
 end

data/lib/action_network_rest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_network_rest
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Grey Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.8.3
+- !ruby/object:Gem::Dependency
+  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'
 description: 
 email:
 - grey@controlshiftlabs.com
@@ -87,9 +129,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -99,6 +144,7 @@ files:
 - bin/console
 - bin/rake
 - bin/rspec
+- example.rb
 - lib/action_network_rest.rb
 - lib/action_network_rest/base.rb
 - lib/action_network_rest/client.rb
@@ -128,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby client for interacting with the ActionNetwork REST API