mobilize-america-client 0.3.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a8aa2a6520cae7a352ffabce99976284b1348b63f16cdc29d9933fb7b5b0881
-  data.tar.gz: d5a2a05390fc6f003042d345a16a2bf903cce4e130347207581f2b7ae5178863
+  metadata.gz: e61d4dfecfc193f37dd96467f4732e354b294743c4a6f7e5abe4fccbcfcdb2b4
+  data.tar.gz: 821a77b1fdacfef7e386c0c35c70b4e493d5249301c397d76eef9866d3c1624b
 SHA512:
-  metadata.gz: a58a2cbc1e069b67a845e16db9a8e4954b63b9fb2f0842cf9fc4913974ca9589e16c6fc7d13e767e1b8837cf9711f85e7358e917ad555c53e17d8fd321142ff9
-  data.tar.gz: c0995119c306cb4e1e96478401a3b91630a52c88990b72c1fe13ce137bd85c5cfe97c8aefbc991c6f601212b420f2d8554a1adfc02a66a3eafebc305fcb3c52d
+  metadata.gz: ba9c9de519868fc5f8f318f9b7d7ba01ab9050673f86847eb71f620e1cf013e5ef21ba10ba7d6b88292c9fd4642b79ff7d93078bcb8be238f5489d218615c22d
+  data.tar.gz: 52d4e7ec4b1f4d6e2380de88c20cd002126634e25339b5eb35433924d551222ac9fbf942a94ae81ffd7cd440b7119b6c71bc02fdb8341614fed76fcf94c120b8

data/.github/workflows/ci.yml

@@ -6,9 +6,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.2.1
           bundler-cache: true
       - run: bundle install
       - run: bundle exec rspec
@@ -16,9 +16,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.2.1
           bundler-cache: true
       - run: bundle install
       - run: bundle exec rubocop

data/.ruby-version

@@ -1 +1 @@
-2.7.4
+3.2.0

data/README.md

@@ -22,12 +22,12 @@ Or install it yourself as:
 
 ## Configuration
 
-By default, the client accesses the public production instance without authentication. 
+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. 
+other endpoints.
 
 `client = MobilizeAmericaClient::Client.new(api_key: 'abc123', api_domain: 'staging-api.mobilize.us')`
 
@@ -37,13 +37,18 @@ other endpoints.
 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)`
 
 Retrieve a specific event
 `client.organization_event(organization_id: 123, event_id: 123)`
 
+Retrieve a list of attendances for a specific event
+`client.organization_event_attendances(organization_id: 123, event_id: 123)`
+
+Retrieve a list of an organization's attendandes
+`client.organization_attendances(organization_id: 123)`
+
 
 ## Development
 

data/VERSION

@@ -1 +1 @@
-0.3.6
+0.5.0

data/lib/mobilize_america_client/client/attendances.rb

@@ -0,0 +1,15 @@
+module MobilizeAmericaClient
+  class Client
+    module Attendances
+      def organization_attendances(organization_id:, updated_since: nil)
+        params = {}
+
+        unless updated_since.nil?
+          params[:updated_since] = updated_since.to_i
+        end
+
+        get(path: "/organizations/#{esc(organization_id)}/attendances", params: params)
+      end
+    end
+  end
+end

data/lib/mobilize_america_client/client/enums.rb

@@ -0,0 +1,9 @@
+module MobilizeAmericaClient
+  class Client
+    module Enums
+      def enums
+        get(path: '/enums')
+      end
+    end
+  end
+end

data/lib/mobilize_america_client/client/events.rb

@@ -2,7 +2,8 @@ module MobilizeAmericaClient
   class Client
     module Events
       def organization_events(organization_id:, timeslot_start: nil, timeslot_end: nil, updated_since: nil,
-                              max_distance_miles: nil, page: nil, per_page: nil, zipcode: nil)
+                              max_distance_miles: nil, page: nil, per_page: nil, zipcode: nil,  event_campaign_id: nil,
+                              tag_ids: nil, event_types: nil, is_virtual: nil, exclude_full: nil)
         params = {}
 
         unless page.nil?
@@ -33,6 +34,26 @@ module MobilizeAmericaClient
           end
         end
 
+        unless event_campaign_id.nil?
+          params[:event_campaign_id] = event_campaign_id.to_i
+        end
+
+        unless tag_ids.nil? || tag_ids.empty?
+          params[:tag_id] = tag_ids.join(',')
+        end
+
+        unless event_types.nil? || event_types.empty?
+          params[:event_types] = event_types.join(',')
+        end
+
+        unless is_virtual.nil?
+          params[:is_virtual] = is_virtual ? 'true' : 'false'
+        end
+
+        unless exclude_full.nil?
+          params[:exclude_full] = exclude_full ? 'true' : 'false'
+        end
+
         get(path: "/organizations/#{esc(organization_id)}/events", params: params)
       end
     end
@@ -40,5 +61,13 @@ module MobilizeAmericaClient
     def organization_event(organization_id:, event_id:)
       get(path: "/organizations/#{esc(organization_id)}/events/#{esc(event_id)}")
     end
+
+    def organization_event_attendances(organization_id:, event_id:)
+      get(path: "/organizations/#{esc(organization_id)}/events/#{esc(event_id)}/attendances")
+    end
+
+    def create_organization_event_attendance(organization_id:, event_id:, attendance_data:)
+      post(path: "/organizations/#{esc(organization_id)}/events/#{esc(event_id)}/attendances", body: attendance_data)
+    end
   end
 end

data/lib/mobilize_america_client/client.rb

@@ -1,4 +1,6 @@
 require 'faraday'
+require 'mobilize_america_client/client/attendances'
+require 'mobilize_america_client/client/enums'
 require 'mobilize_america_client/client/events'
 require 'mobilize_america_client/client/organizations'
 require 'mobilize_america_client/request'
@@ -14,10 +16,12 @@ module MobilizeAmericaClient
 
       api_domain = options[:api_domain] || API_DOMAIN
 
-      @connection = Faraday.new(url: "https://#{api_domain}")
+      @connection = Faraday.new(url: "https://#{api_domain}", request: { params_encoder: Faraday::FlatParamsEncoder })
     end
 
     include MobilizeAmericaClient::Request
+    include MobilizeAmericaClient::Client::Attendances
+    include MobilizeAmericaClient::Client::Enums
     include MobilizeAmericaClient::Client::Events
     include MobilizeAmericaClient::Client::Organizations
   end

data/lib/mobilize_america_client/errors.rb

@@ -1,4 +1,7 @@
 module MobilizeAmericaClient
   class NotFoundError < StandardError
   end
+
+  class UnauthorizedError < StandardError
+  end
 end

data/lib/mobilize_america_client/request.rb

@@ -6,7 +6,11 @@ module MobilizeAmericaClient
     API_BASE_PATH = '/v1'.freeze
 
     def get(path:, params: {})
-      request(method: :get, path: path, params: params)
+      request(method: :get, path:, params:)
+    end
+
+    def post(path:, body:)
+      request(method: :post, path:, body:)
     end
 
     private
@@ -28,6 +32,10 @@ module MobilizeAmericaClient
         req.body = ::JSON.generate(body) unless body.empty?
       end
 
+      if response.status == 401
+        raise MobilizeAmericaClient::UnauthorizedError
+      end
+
       if response.status == 404
         raise MobilizeAmericaClient::NotFoundError
       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.6 ruby lib
+# stub: mobilize-america-client 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mobilize-america-client".freeze
-  s.version = "0.3.6"
+  s.version = "0.5.0"
 
   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 = "2021-09-14"
+  s.date = "2023-02-23"
   s.email = "grey@controlshiftlabs.com".freeze
   s.executables = ["console".freeze, "setup".freeze]
   s.extra_rdoc_files = [
@@ -37,12 +37,16 @@ Gem::Specification.new do |s|
     "example.rb",
     "lib/mobilize_america_client.rb",
     "lib/mobilize_america_client/client.rb",
+    "lib/mobilize_america_client/client/attendances.rb",
+    "lib/mobilize_america_client/client/enums.rb",
     "lib/mobilize_america_client/client/events.rb",
     "lib/mobilize_america_client/client/organizations.rb",
     "lib/mobilize_america_client/errors.rb",
     "lib/mobilize_america_client/request.rb",
     "mobilize-america-client.gemspec",
+    "spec/client/attendances_spec.rb",
     "spec/client/client_spec.rb",
+    "spec/client/enums_spec.rb",
     "spec/client/events_spec.rb",
     "spec/client/organizations_spec.rb",
     "spec/fixtures/organizations.json",
@@ -50,40 +54,18 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/controlshift/mobilize_america_client".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.9".freeze
+  s.rubygems_version = "3.4.3".freeze
   s.summary = "Client gem for the MobilizeAmerica API".freeze
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  s.specification_version = 4
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<faraday>.freeze, ["> 0.15"])
-      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
-      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"])
-      s.add_dependency(%q<juwelier>.freeze, [">= 0"])
-      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"])
-    s.add_dependency(%q<rspec>.freeze, [">= 0"])
-    s.add_dependency(%q<juwelier>.freeze, [">= 0"])
-    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
+  s.add_runtime_dependency(%q<faraday>.freeze, ["> 0.15"])
+  s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+  s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+  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"])
 end
 

data/spec/client/attendances_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe MobilizeAmericaClient::Client::Attendances do
+  let(:api_key) { 'abcde-123456' }
+  let(:expected_headers) { {'Content-Type' => 'application/json', 'Authorization' => "Bearer #{api_key}"} }
+  let(:base_url) { "https://#{MobilizeAmericaClient::Client::API_DOMAIN}#{MobilizeAmericaClient::Client::API_BASE_PATH}" }
+
+  subject { MobilizeAmericaClient::Client.new(api_key: api_key) }
+
+  describe '#organization_attendances' do
+    let(:org_id) { 123 }
+    let(:attendances_url) { "#{base_url}/organizations/#{org_id}/attendances" }
+    let(:response) { {'data' => [{'id' => 1, 'event' => {'id' => 1111}}, {'id' => 2, 'event' => {'id' => 2222}}]} }
+
+    context 'unauthenticated request' do
+      let(:api_key) { nil }
+
+      it 'should raise if response status is 401' do
+        stub_request(:get, attendances_url).with(headers: {'Content-Type' => 'application/json'}).to_return(status: 401, body: {error: 'unauthorized'}.to_json)
+
+        expect { subject.organization_attendances(organization_id: org_id) }.to raise_error MobilizeAmericaClient::UnauthorizedError
+      end
+    end
+
+    it 'should raise if response status is 404' do
+      stub_request(:get, attendances_url).with(headers: expected_headers).to_return(status: 404, body: {error: 'not found'}.to_json)
+
+      expect { subject.organization_attendances(organization_id: org_id) }.to raise_error MobilizeAmericaClient::NotFoundError
+    end
+
+    it 'should call the endpoint and return JSON' do
+      stub_request(:get, attendances_url).with(headers: expected_headers).to_return(body: response.to_json)
+      expect(subject.organization_attendances(organization_id: org_id)).to eq(response)
+    end
+
+    it 'should escape the organization ID' do
+      expected_url = "#{base_url}/organizations/foo%2Fbar/attendances"
+      stub_request(:get, expected_url).with(headers: expected_headers).to_return(body: response.to_json)
+      expect(subject.organization_attendances(organization_id: 'foo/bar')).to eq(response)
+    end
+
+    it 'should support an updated_since parameter' do
+      updated_since = Time.new
+      stub_request(:get, attendances_url)
+        .with(headers: expected_headers, query: {updated_since: updated_since.to_i})
+        .to_return(body: response.to_json)
+      expect(subject.organization_attendances(organization_id: org_id, updated_since: updated_since)).to eq(response)
+    end
+  end
+end

data/spec/client/enums_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe MobilizeAmericaClient::Client::Enums do
+  let(:standard_headers) { {'Content-Type' => 'application/json'} }
+
+  subject { MobilizeAmericaClient::Client.new }
+
+  let(:base_url) { "https://#{MobilizeAmericaClient::Client::API_DOMAIN}#{MobilizeAmericaClient::Client::API_BASE_PATH}" }
+
+  describe '#enums' do
+    let(:enums_url) { "#{base_url}/enums" }
+    let(:response) { {'hello' => 'world'} }
+
+    it 'should call the endpoint and return JSON' do
+      stub_request(:get, enums_url).with(headers: standard_headers).to_return(body: response.to_json)
+      expect(subject.enums).to eq response
+    end
+  end
+end

data/spec/client/events_spec.rb

@@ -75,6 +75,41 @@ RSpec.describe MobilizeAmericaClient::Client::Events do
         .to_return(body: response.to_json)
       expect(subject.organization_events(organization_id: org_id, page: 2, per_page: 100)).to eq(response)
     end
+
+    it 'should support an event campaign id parameter' do
+      stub_request(:get, events_url)
+        .with(headers: standard_headers, query: {event_campaign_id: 1})
+        .to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: org_id, event_campaign_id: 1)).to eq(response)
+    end
+
+    it 'should support a tag ids parameter' do
+      stub_request(:get, events_url)
+        .with(headers: standard_headers, query: {tag_id: 'foo,bar'})
+        .to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: org_id, tag_ids: ['foo', 'bar'])).to eq(response)
+    end
+
+    it 'should support an event types parameter' do
+      stub_request(:get, events_url)
+        .with(headers: standard_headers, query: {event_types: 'foo,bar'})
+        .to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: org_id, event_types: ['foo', 'bar'])).to eq(response)
+    end
+
+    it 'should support a virtual parameter' do
+      stub_request(:get, events_url)
+        .with(headers: standard_headers, query: {is_virtual: true})
+        .to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: org_id, is_virtual: true)).to eq(response)
+    end
+
+    it 'should support an exclude full parameter' do
+      stub_request(:get, events_url)
+        .with(headers: standard_headers, query: {exclude_full: true})
+        .to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: org_id, exclude_full: true)).to eq(response)
+    end
   end
 
   describe '#organization_event' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobilize-america-client
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Grey Moore
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -150,12 +150,16 @@ files:
 - example.rb
 - lib/mobilize_america_client.rb
 - lib/mobilize_america_client/client.rb
+- lib/mobilize_america_client/client/attendances.rb
+- lib/mobilize_america_client/client/enums.rb
 - lib/mobilize_america_client/client/events.rb
 - lib/mobilize_america_client/client/organizations.rb
 - lib/mobilize_america_client/errors.rb
 - lib/mobilize_america_client/request.rb
 - mobilize-america-client.gemspec
+- spec/client/attendances_spec.rb
 - spec/client/client_spec.rb
+- spec/client/enums_spec.rb
 - spec/client/events_spec.rb
 - spec/client/organizations_spec.rb
 - spec/fixtures/organizations.json
@@ -179,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.3
 signing_key:
 specification_version: 4
 summary: Client gem for the MobilizeAmerica API