mobilize-america-client 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70f5bf5dfc9d0f511b818610c53141b895eb53ee95df849fc489ac291e042181
-  data.tar.gz: ad53e19f58d568c058f792d1e502ccfe189359aa24d73494e16beba95d6c69ee
+  metadata.gz: 8a0362285775791640e9e587d2ea5875981615bf134364f5438d2ce878472eb8
+  data.tar.gz: 1497262d8a8bacde3d68082e4766b883b677480960fe33744994a87853ceb2cd
 SHA512:
-  metadata.gz: 92b5acafbc92e78cda5a536050632265c62173cdb5ea6e19692776ff4b4f127a71a2a1a12076b0ef8d671ff623c5cf66668f78ffeed431d59ef666bbe8311b5a
-  data.tar.gz: 21aa6d6616adb3fe6608f268f0b1ed70d799c5f7f78c64fb1f314ac829b05c2bec13fa72b74248f44ae624cec297e428ba1b9d3d7b841d069e120c9923f27e53
+  metadata.gz: d455bb7eda9dddf648794b53f48cdc4ccf7630492b0cc4709c17844c8d4978471df75e57743e91c320fedff7621132997030e2e7d48874c0550a2bc8b8c9a698
+  data.tar.gz: e7f5a5ef755ab7b485e9ac8a89a97fb5ea663a507fef97ed5a3b3f62d5c5a25259f5eb77286b5472be0aca2517ba225aef626b335e95c40f726d98b20c946daa

data/Gemfile

@@ -8,4 +8,6 @@ group :development do
   gem 'rake'
   gem 'webmock'
   gem 'rubocop'
+  gem 'dotenv'
+  gem 'byebug'
 end

data/README.md

@@ -20,11 +20,29 @@ Or install it yourself as:
 
     $ gem install mobilize-america-client
 
+## Configuration
+
+By default, the client accesses the public production instance without authentication. 
+
+`client = MobilizeAmericaClient::Client.new`
+
+It is also possible to provide an API key to the client to make authenticated requests, or to specify
+other endpoints. 
+
+`client = MobilizeAmericaClient::Client.new(api_key: 'abc123', api_domain: 'staging-api.mobilize.us')`
+
+
 ## Usage
 
-For now, the gem only supports listing an organization's events.
+Retrieve a list of organizations
+`client.organizations(page: 2, per_page: 50)`
+
+
+Retrieve a list of an organization's events
+`client.organization_events(organization_id: 123)`
 
-`MobilizeAmericaClient::Client.new.organization_events(organization_id: 123)`
+Retrieve a specific event
+`client.organization_event(organization_id: 123, event_id: 123)`
 
 
 ## Development

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

data/example.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'mobilize_america_client'
+require 'dotenv'
+require 'byebug'
+
+Dotenv.load('.env')
+
+client = MobilizeAmericaClient::Client.new(api_key: ENV['API_KEY'], api_domain: ENV['API_DOMAIN']) # rubocop:disable Lint/UselessAssignment
+
+puts "Ready to call Mobilize America using 'client' object"
+byebug # rubocop:disable Lint/Debugger
+
+puts "Bye!"

data/lib/mobilize_america_client.rb

@@ -2,8 +2,8 @@ require 'mobilize_america_client/client'
 
 module MobilizeAmerica
   class << self
-    def new
-      MobilizeAmericaClient::Client.new
+    def new(options = {})
+      MobilizeAmericaClient::Client.new(options)
     end
   end
 end

data/lib/mobilize_america_client/client.rb

@@ -6,9 +6,14 @@ require 'mobilize_america_client/request'
 module MobilizeAmericaClient
   class Client
     attr_reader :connection
+    attr_accessor :api_key
 
-    def initialize
-      @connection = Faraday.new(url: "https://#{API_DOMAIN}")
+    def initialize(options = {})
+      self.api_key = options[:api_key]
+
+      api_domain = options[:api_domain] || API_DOMAIN
+
+      @connection = Faraday.new(url: "https://#{api_domain}")
     end
 
     include MobilizeAmericaClient::Request

data/lib/mobilize_america_client/client/events.rb

@@ -36,5 +36,9 @@ module MobilizeAmericaClient
         get(path: "/organizations/#{esc(organization_id)}/events", params: params)
       end
     end
+
+    def organization_event(organization_id:, event_id:)
+      get(path: "/organizations/#{esc(organization_id)}/events/#{esc(event_id)}")
+    end
   end
 end

data/lib/mobilize_america_client/request.rb

@@ -20,6 +20,11 @@ module MobilizeAmericaClient
         req.path = "#{API_BASE_PATH}#{path}"
         req.params = params
         req.headers['Content-Type'] = 'application/json'
+
+        unless api_key.nil?
+          req.headers['Authorization'] = "Bearer #{api_key}"
+        end
+
         req.body = ::JSON.generate(body) unless body.empty?
       end
 

data/mobilize-america-client.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: mobilize-america-client 0.3.4 ruby lib
+# stub: mobilize-america-client 0.3.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mobilize-america-client".freeze
-  s.version = "0.3.4"
+  s.version = "0.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Grey Moore".freeze]
-  s.date = "2020-10-13"
+  s.date = "2020-10-14"
   s.email = "grey@controlshiftlabs.com".freeze
   s.executables = ["console".freeze, "setup".freeze]
   s.extra_rdoc_files = [
@@ -32,12 +32,14 @@ Gem::Specification.new do |s|
     "VERSION",
     "bin/console",
     "bin/setup",
+    "example.rb",
     "lib/mobilize_america_client.rb",
     "lib/mobilize_america_client/client.rb",
     "lib/mobilize_america_client/client/events.rb",
     "lib/mobilize_america_client/client/organizations.rb",
     "lib/mobilize_america_client/request.rb",
     "mobilize-america-client.gemspec",
+    "spec/client/client_spec.rb",
     "spec/client/events_spec.rb",
     "spec/client/organizations_spec.rb",
     "spec/fixtures/organizations.json",
@@ -45,7 +47,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/controlshift/mobilize_america_client".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.3".freeze
+  s.rubygems_version = "3.0.8".freeze
   s.summary = "Client gem for the MobilizeAmerica API".freeze
 
   if s.respond_to? :specification_version then
@@ -58,6 +60,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rake>.freeze, [">= 0"])
       s.add_development_dependency(%q<webmock>.freeze, [">= 0"])
       s.add_development_dependency(%q<rubocop>.freeze, [">= 0"])
+      s.add_development_dependency(%q<dotenv>.freeze, [">= 0"])
+      s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
     else
       s.add_dependency(%q<faraday>.freeze, ["> 0.15"])
       s.add_dependency(%q<rspec>.freeze, [">= 0"])
@@ -65,6 +69,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rake>.freeze, [">= 0"])
       s.add_dependency(%q<webmock>.freeze, [">= 0"])
       s.add_dependency(%q<rubocop>.freeze, [">= 0"])
+      s.add_dependency(%q<dotenv>.freeze, [">= 0"])
+      s.add_dependency(%q<byebug>.freeze, [">= 0"])
     end
   else
     s.add_dependency(%q<faraday>.freeze, ["> 0.15"])
@@ -73,6 +79,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rake>.freeze, [">= 0"])
     s.add_dependency(%q<webmock>.freeze, [">= 0"])
     s.add_dependency(%q<rubocop>.freeze, [">= 0"])
+    s.add_dependency(%q<dotenv>.freeze, [">= 0"])
+    s.add_dependency(%q<byebug>.freeze, [">= 0"])
   end
 end
 

data/spec/client/client_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe MobilizeAmericaClient::Client do
+  subject { MobilizeAmericaClient::Client.new(api_key: 'abc123') }
+
+  it 'should set the api_key' do
+    expect(subject.api_key).to eq('abc123')
+  end
+end

data/spec/client/events_spec.rb

@@ -14,13 +14,13 @@ RSpec.describe MobilizeAmericaClient::Client::Events do
 
     it 'should call the endpoint and return JSON' do
       stub_request(:get, events_url).with(headers: standard_headers).to_return(body: response.to_json)
-      expect(subject.organization_events(organization_id: org_id)).to eq response
+      expect(subject.organization_events(organization_id: org_id)).to eq(response)
     end
 
     it 'should escape the organization ID' do
       expected_url = "#{base_url}/organizations/foo%2Fbar/events"
       stub_request(:get, expected_url).with(headers: standard_headers).to_return(body: response.to_json)
-      expect(subject.organization_events(organization_id: 'foo/bar')).to eq response
+      expect(subject.organization_events(organization_id: 'foo/bar')).to eq(response)
     end
 
     it 'should support a timeslot_start parameter' do
@@ -45,7 +45,7 @@ RSpec.describe MobilizeAmericaClient::Client::Events do
       stub_request(:get, events_url)
         .with(headers: standard_headers, query: {updated_since: updated_since.to_i})
         .to_return(body: response.to_json)
-      expect(subject.organization_events(organization_id: org_id, updated_since: updated_since)).to eq response
+      expect(subject.organization_events(organization_id: org_id, updated_since: updated_since)).to eq(response)
     end
 
     it 'should support a zipcode parameter' do
@@ -53,21 +53,35 @@ RSpec.describe MobilizeAmericaClient::Client::Events do
       stub_request(:get, events_url)
         .with(headers: standard_headers, query: {zipcode: zipcode})
         .to_return(body: response.to_json)
-      expect(subject.organization_events(organization_id: org_id, zipcode: zipcode)).to eq response
+      expect(subject.organization_events(organization_id: org_id, zipcode: zipcode)).to eq(response)
     end
 
     it 'should support a max_dist parameter to go with zipcode' do
       stub_request(:get, events_url)
         .with(headers: standard_headers, query: {zipcode: '23456', max_dist: 100})
         .to_return(body: response.to_json)
-      expect(subject.organization_events(organization_id: org_id, zipcode: '23456', max_distance_miles: 100)).to eq response
+      expect(subject.organization_events(organization_id: org_id, zipcode: '23456', max_distance_miles: 100)).to eq(response)
     end
 
     it 'should support pagination parameters' do
       stub_request(:get, events_url)
         .with(headers: standard_headers, query: {page: 2, per_page: 100})
         .to_return(body: response.to_json)
-      expect(subject.organization_events(organization_id: org_id, page: 2, per_page: 100)).to eq response
+      expect(subject.organization_events(organization_id: org_id, page: 2, per_page: 100)).to eq(response)
+    end
+  end
+
+  describe '#organization_event' do
+    let(:org_id) { 123 }
+    let(:event_id) { 456 }
+    let(:events_url) { "#{base_url}/organizations/#{org_id}/events/#{event_id}" }
+    let(:response) { '{"hello": "world"}' }
+
+    it 'should support pagination parameters' do
+      stub_request(:get, events_url)
+          .with(headers: standard_headers)
+          .to_return(body: response.to_json)
+      expect(subject.organization_event(organization_id: org_id, event_id: event_id)).to eq(response)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobilize-america-client
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Grey Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: byebug
+  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
 executables:
@@ -117,12 +145,14 @@ files:
 - VERSION
 - bin/console
 - bin/setup
+- example.rb
 - lib/mobilize_america_client.rb
 - lib/mobilize_america_client/client.rb
 - lib/mobilize_america_client/client/events.rb
 - lib/mobilize_america_client/client/organizations.rb
 - lib/mobilize_america_client/request.rb
 - mobilize-america-client.gemspec
+- spec/client/client_spec.rb
 - spec/client/events_spec.rb
 - spec/client/organizations_spec.rb
 - spec/fixtures/organizations.json
@@ -146,7 +176,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: Client gem for the MobilizeAmerica API