upland_mobile_commons_rest 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f34644e11282b6cd0234d4b376ad6b0bec67abb4a0385bef99b56fa1233eea92
-  data.tar.gz: 47b415580a1fac3855a3b670f10ae3f1651af10908b9c60a0e7bc72a8f8910b3
+  metadata.gz: 6af9508f63531c934fab5b8d4129d5132609bf316e846cc7dedc02e255b8f809
+  data.tar.gz: 36186a816bdcb8841f48d2f5f9af4c484c0c516af6529b4c255bbac42101b0ea
 SHA512:
-  metadata.gz: 5cfbdef2b235b17763688476472694b1e558ea4b900699960c96b1c602ded91b76007ff8370d4ae03ce94e272a6afa1e74b4df65f329b084700a97001f198ae3
-  data.tar.gz: 0ce777ff7b280913f9ab2100f06c2048136ef47aa920d967cef76013f16b700b81a930487cae603c5379f280965a32bd8427ee7941f1ee22dcd4e25a2b7dfdbc
+  metadata.gz: 74ac3b2e39fd5e888c4d0b66097dfab977306a23b353a667a9eb5d51df74ac4945542cfd35ea3e951a928dfa45382ab4e280e18e0257bd92cf5d0c19e4bdb270
+  data.tar.gz: 0037b025610ce66dbdb592e8e4b8010085d1c2fc30b9ff0ee3c0cc96b8af00771e04fc5fe0f222dfff756a2061e4eb126eb635238eef967c5c95f67a4f79256b

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle install
+      - run: bundle exec rspec
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle install
+      - run: bundle exec rubocop

data/.ruby-gemset

@@ -0,0 +1 @@
+upland_mobile_commons_rest

data/.ruby-version

@@ -0,0 +1 @@
+2.7.4

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
@@ -8,14 +10,14 @@ gem 'vertebrae'
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "shoulda", ">= 0"
-  gem "rdoc", "> 3.12"
-  gem "bundler", "> 2.0"
-  gem "juwelier", git: 'https://github.com/flajann2/juwelier.git'
-  gem "simplecov", ">= 0"
-  gem "dotenv"
-  gem "byebug"
-  gem "rubocop"
-  gem "rspec"
-  gem "webmock"
+  gem 'bundler', '> 2.0'
+  gem 'byebug'
+  gem 'dotenv'
+  gem 'juwelier', git: 'https://github.com/flajann2/juwelier.git'
+  gem 'rdoc', '> 3.12'
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'shoulda', '>= 0'
+  gem 'simplecov', '>= 0'
+  gem 'webmock'
 end

data/README.md

@@ -1,5 +1,5 @@
 # Upland Mobile Commons Ruby Gem
-[![Build Status](https://travis-ci.org/controlshift/upland_mobile_commons_rest.svg?branch=master)](https://travis-ci.org/controlshift/upland_mobile_commons_rest)
+[![CI Status](https://github.com/controlshift/upland_mobile_commons_rest/actions/workflows/ci.yml/badge.svg)](https://github.com/controlshift/upland_mobile_commons_rest/actions/workflows/ci.yml)
 
 A ruby gem for interacting with the Upland Mobile Commons API.
 

data/Rakefile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'rubygems'
@@ -6,42 +5,40 @@ require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
 require 'juwelier'
 Juwelier::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "upland_mobile_commons_rest"
-  gem.homepage = "http://github.com/controlshift/upland_mobile_commons_rest"
-  gem.license = "MIT"
-  gem.summary = %Q{API client gem for Upland Mobile Commons}
-  gem.description = %Q{A simple ruby API client gem for the Upland Mobile Commons REST API}
-  gem.email = "nathan@controlshiftlabs.com"
-  gem.authors = ["Nathan Woodhull"]
+  gem.name = 'upland_mobile_commons_rest'
+  gem.homepage = 'http://github.com/controlshift/upland_mobile_commons_rest'
+  gem.license = 'MIT'
+  gem.summary = %(API client gem for Upland Mobile Commons)
+  gem.description = %(A simple ruby API client gem for the Upland Mobile Commons REST API)
+  gem.email = 'team@controlshiftlabs.com'
+  gem.authors = ['Kathy Lu', 'Diego Marcet', 'Grey Moore', 'Nathan Woodhull']
 
   # dependencies defined in Gemfile
 end
 Juwelier::RubygemsDotOrgTasks.new
 
-desc "Code coverage detail"
+desc 'Code coverage detail'
 task :simplecov do
-  ENV['COVERAGE'] = "true"
+  ENV['COVERAGE'] = 'true'
   Rake::Task['test'].execute
 end
 
-
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-
-task :default => :spec
+task default: :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "upland_mobile_commons_rest #{version}"

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.0

data/example.rb

@@ -1,4 +1,5 @@
-  
+# frozen_string_literal: true
+
 $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
 
 require 'upland_mobile_commons_rest'
@@ -7,9 +8,9 @@ require 'byebug'
 
 Dotenv.load('.env')
 
-client = UplandMobileCommonsRest.new(username: ENV['USERNAME'], password: ENV['PASSWORD'] ) # rubocop:disable Lint/UselessAssignment
+client = UplandMobileCommonsRest.new(username: ENV['USERNAME'], password: ENV['PASSWORD']) # rubocop:disable Lint/UselessAssignment
 
 puts "Ready to call MobileCommons API using 'client' object"
 byebug # rubocop:disable Lint/Debugger
 
-puts "Bye!"
+puts 'Bye!'

data/lib/upland_mobile_commons_rest/base.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module UplandMobileCommonsRest
   class Base < Vertebrae::Model
     def url_escape(string)
       CGI.escape(string.to_s)
     end
-
   end
 end

data/lib/upland_mobile_commons_rest/campaigns.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module UplandMobileCommonsRest
   class Campaigns < Base
-
     def base_path
       'campaigns'
     end

data/lib/upland_mobile_commons_rest/client.rb

@@ -4,7 +4,7 @@ module UplandMobileCommonsRest
   class Client < Vertebrae::API
     attr_accessor :username, :password, :company_key
 
-    def initialize(options={}, &block)
+    def initialize(options = {}, &block)
       self.username = options[:username]
       self.password = options[:password]
       self.company_key = options[:company_key]
@@ -25,15 +25,19 @@ module UplandMobileCommonsRest
 
     def setup
       connection.stack do |builder|
+        # Request middlewares, in the order they should run
         builder.use Faraday::Request::Multipart
         builder.use Faraday::Request::UrlEncoded
         if connection.configuration.authenticated?
-          builder.use Faraday::Request::BasicAuthentication, connection.configuration.username, connection.configuration.password
+          builder.use Faraday::Request::BasicAuthentication, connection.configuration.username,
+                      connection.configuration.password
         end
 
+        # Response middlewares, in the *reverse* order they should run
         builder.use UplandMobileCommonsRest::TypedErrorMiddleware
         builder.use Faraday::Response::Logger if ENV['DEBUG']
         builder.use FaradayMiddleware::ParseXml
+        builder.use UplandMobileCommonsRest::HttpErrorMiddleware
 
         builder.adapter connection.configuration.adapter
       end

data/lib/upland_mobile_commons_rest/errors.rb

@@ -1,47 +1,137 @@
+# frozen_string_literal: true
+
 module UplandMobileCommonsRest
+  class NetworkError < StandardError
+    attr_accessor :status, :body
+
+    def initialize(params)
+      self.status = params[:status]
+      self.body = params[:body]
+
+      # Including the parentheses means we call #super with no arguments,
+      # rather than passing params along. We do this to avoid the params being
+      # treated as the "message" of the exception.
+      super()
+    end
+
+    def to_s
+      "#{super}\n status: #{status}\n body: #{body}"
+    end
+  end
+
+  class BadGatewayError < NetworkError; end
+  class GatewayTimeoutError < NetworkError; end
+
+  # This middleware runs *before* XML parsing, so we can include the raw response body in the exception.
+  class HttpErrorMiddleware < Faraday::Response::Middleware
+    def on_complete(response)
+      status_code = response[:status].to_i
+
+      # Raise an exception for 5xx errors.
+      # Q: Shouldn't we also raise for 4xx errors?
+      # A: We let TypedErrorMiddleware handle those, in case they have useful info.
+      case status_code
+      when 502
+        raise BadGatewayError.new(response)
+      when 503
+        if /This website is under heavy load/.match?(response.body)
+          raise HeavyLoadError, response.body
+        else
+          raise UnknownError, response.body
+        end
+      when 504
+        raise GatewayTimeoutError.new(response)
+      when 500...600
+        # Just in case we get other 5xx errors, raise something for those
+        # This has not happened that we know of, but better safe than sorry!
+        raise UnknownError, response.inspect
+      end
+    end
+  end
+
   class MobileCommonsError < StandardError
     attr_accessor :code, :raw_message
   end
 
+  class HeavyLoadError < MobileCommonsError; end
+
   class UnknownError < MobileCommonsError; end
+
   class InvalidCampaignId < MobileCommonsError; end
+
   class InvalidBroadcastTime < MobileCommonsError; end
+
   class InvalidMessageBody < MobileCommonsError; end
+
   class InvalidCompanyId < MobileCommonsError; end
+
   class InvalidPhoneNumber < MobileCommonsError; end
+
   class InvalidGroupId < MobileCommonsError; end
+
   class InvalidStartTime < MobileCommonsError; end
+
   class InvalidEndTime < MobileCommonsError; end
+
   class InvalidMdataId < MobileCommonsError; end
+
   class InvalidKey < MobileCommonsError; end
+
   class PhoneIsNotOptedIntoThisCampaign < MobileCommonsError; end
+
   class InvalidFundraisingId < MobileCommonsError; end
+
   class InvalidMessageTemplate < MobileCommonsError; end
+
   class PhoneIsNotTextable < MobileCommonsError; end
+
   class InvalidMconnectId < MobileCommonsError; end
+
   class InvalidQueryParameters < MobileCommonsError; end
+
   class TooManyMessages < MobileCommonsError; end
+
   class InvalidName < MobileCommonsError; end
+
   class InvalidOptInPath < MobileCommonsError; end
+
   class InvalidUrl < MobileCommonsError; end
+
   class InvalidAttachment < MobileCommonsError; end
+
   class InvalidBroadcastId < MobileCommonsError; end
+
   class InvalidBroadcastStateChange < MobileCommonsError; end
+
   class BroadcastHasNotBeenSent < MobileCommonsError; end
+
   class MessageTemplateInvalid < MobileCommonsError; end
+
   class InvalidUserId < MobileCommonsError; end
+
   class APIRateLimitExceeded < MobileCommonsError; end
+
   class MissingPhoneNumberParameter < MobileCommonsError; end
+
   class InvalidProfileSaveItemBehavior < MobileCommonsError; end
+
   class InvalidProfileAttributes < MobileCommonsError; end
+
   class InvalidPreviousId < MobileCommonsError; end
+
   class InvalidTagName < MobileCommonsError; end
+
   class InvalidTagParameters < MobileCommonsError; end
+
   class InvalidShortcodeId < MobileCommonsError; end
+
   class InvalidDateRange < MobileCommonsError; end
+
   class InvalidScheduledMessageId < MobileCommonsError; end
+
   class MessageHasAlreadyBeenSent < MobileCommonsError; end
 
+  # This middleware runs *after* XML parsing, because it uses information extracted from the body
   class TypedErrorMiddleware < Faraday::Response::Middleware
     POSSIBLE_ERRORS = {
       '0' => UnknownError,
@@ -82,17 +172,15 @@ module UplandMobileCommonsRest
       '35' => InvalidDateRange,
       '36' => InvalidScheduledMessageId,
       '37' => MessageHasAlreadyBeenSent
-    }
+    }.freeze
 
     def on_complete(response)
       # First ensure responses without the expected format are correctly handled
-      if response.body.nil? || response.body['response'].nil?
-        raise UnknownError.new(response.inspect)
-      end
+      raise UnknownError, response.inspect if response.body.nil? || response.body['response'].nil?
 
       # Now verify that response was successful or raise a corresponding exception otherwise
       if response.body['response']['success'] == 'false'
-        raise POSSIBLE_ERRORS[response.body['response']['error']['id']].new(response.body['response']['error']['message'])
+        raise POSSIBLE_ERRORS[response.body['response']['error']['id']], response.body['response']['error']['message']
       end
     end
   end

data/lib/upland_mobile_commons_rest/groups.rb

@@ -1,12 +1,22 @@
+# frozen_string_literal: true
+
 module UplandMobileCommonsRest
   class Groups < Base
-
     def base_path
       'groups'
     end
 
-    def list
-      resp = client.get_request(base_path)
+    def list(page: nil, limit: nil)
+      params = []
+
+      params << "page=#{url_escape(page)}" if page
+
+      params << "limit=#{url_escape(limit)}" if limit
+
+      request_path = base_path
+      request_path += "?#{params.join('&')}" if params.any?
+
+      resp = client.get_request(request_path)
       resp.body['response']['groups']['group']
     end
 

data/lib/upland_mobile_commons_rest/profiles.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module UplandMobileCommonsRest
   class Profiles < Base
     def base_path

data/lib/upland_mobile_commons_rest.rb

@@ -17,4 +17,4 @@ require 'upland_mobile_commons_rest/base'
 require 'upland_mobile_commons_rest/campaigns'
 require 'upland_mobile_commons_rest/groups'
 require 'upland_mobile_commons_rest/profiles'
-require 'upland_mobile_commons_rest/errors'
+require 'upland_mobile_commons_rest/errors'

data/spec/campaigns_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe UplandMobileCommonsRest::Campaigns do
@@ -26,4 +28,4 @@ describe UplandMobileCommonsRest::Campaigns do
       end
     end
   end
-end
+end

data/spec/client_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe UplandMobileCommonsRest::Client do
@@ -15,4 +17,122 @@ describe UplandMobileCommonsRest::Client do
       expect(campaigns.client).to eq(subject)
     end
   end
+
+  describe 'error handling' do
+    let(:request_params) { {example: 'data'} }
+
+    subject { UplandMobileCommonsRest::Client.new(username: 'foo', password: 'bar') }
+
+    before :each do
+      stub_request(:post, 'https://secure.mcommons.com/api/do_something')
+        .to_return(status: response_status, body: response_body)
+    end
+
+    shared_examples_for 'error code parsing' do
+      UplandMobileCommonsRest::TypedErrorMiddleware::POSSIBLE_ERRORS.each do |code, ex_type|
+        context "response body with success=false and error code #{code}" do
+          let(:response_body) do
+            <<~XML
+            <response success="false">
+              <error id="#{code}" message="This is not correct!"/>
+            </response>
+            XML
+          end
+
+          it "should raise #{ex_type}" do
+            expect{ subject.post_request('do_something', request_params) }.to raise_error(ex_type)
+          end
+        end
+      end
+    end
+
+    context '200 status response' do
+      let(:response_status) { 200 }
+
+      context 'no response body' do
+        let(:response_body) { nil }
+
+        it 'should raise an UnknownError' do
+          expect{ subject.post_request('do_something', request_params) }.to raise_error(UplandMobileCommonsRest::UnknownError)
+        end
+      end
+
+      context 'response body without <response> tag' do
+        let(:response_body) { '<body>Well, this is unexpected!</body>' }
+
+        it 'should raise an UnknownError' do
+          expect{ subject.post_request('do_something', request_params) }.to raise_error(UplandMobileCommonsRest::UnknownError)
+        end
+      end
+
+      context 'response body with success=true' do
+        let(:response_body) { '<response success="true">hurray!</response>' }
+
+        it 'should not raise' do
+          expect{ subject.post_request('do_something', request_params) }.not_to raise_error
+        end
+      end
+
+      include_examples 'error code parsing'
+    end
+
+    context '400 status response' do
+      let(:response_status) { 400 }
+
+      include_examples 'error code parsing'
+    end
+
+    context '502 status response' do
+      let(:response_status) { 502 }
+      let(:response_body) { '<html><head><title>502 Bad Gateway</title></head><body><center><h1>502 Bad Gateway</h1></center></body></html>' }
+
+      it 'should raise an BadGatewayError' do
+        expect do
+          subject.post_request('do_something', request_params)
+        end.to raise_error(UplandMobileCommonsRest::BadGatewayError) do |error|
+          expect(error.body).to eq response_body
+          expect(error.to_s).to include(response_body)
+        end
+      end
+    end
+
+    context '503 status response' do
+      let(:response_status) { 503 }
+      let(:response_body) { '<html><head><title>503 Internal Server Error</title></head><body><center><h1>503 Internal Server Error</h1></center></body></html>' }
+
+      it 'should raise an UnknownError' do
+        expect do
+          subject.post_request('do_something', request_params)
+        end.to raise_error(UplandMobileCommonsRest::UnknownError) do |error|
+          expect(error.to_s).to include(response_body)
+        end
+      end
+
+      context 'with Heavy Load message' do
+        let(:response_body) { "<h2>This website is under heavy load (queue full)</h2><p>We're sorry, too many people are accessing this website at the same time. We're working on this problem. Please try again later.</p>" }
+
+        it 'should raise a HeavyLoadError' do
+          expect do
+            subject.post_request('do_something', request_params)
+          end.to raise_error(UplandMobileCommonsRest::HeavyLoadError) do |error|
+            expect(error.to_s).to include(response_body)
+          end
+        end
+      end
+    end
+
+    context '504 status response' do
+      let(:response_status) { 504 }
+      let(:response_body) { '<html><head><title>504 Gateway Time-out</title></head><body><center><h1>504 Gateway Time-out</h1></center></body></html>' }
+
+      it 'should raise an GatewayTimeoutError' do
+        expect do
+          subject.post_request('do_something', request_params)
+        end.to raise_error(UplandMobileCommonsRest::GatewayTimeoutError) do |error|
+          expect(error.body).to eq response_body
+          expect(error.to_s).to include(response_body)
+        end
+      end
+    end
+  end
 end

data/spec/fixtures/error_profile_not_found.xml

@@ -0,0 +1,3 @@
+<response success="false">
+  <error id="5" message="Invalid phone number" />
+</response>

data/spec/fixtures/profiles/get.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response success="true">
+  <profile id="34xxxxxxx">
+    <first_name>John</first_name>
+    <last_name>Doe</last_name>
+    <phone_number>12025551234</phone_number>
+    <email />
+    <status>Active subscriber</status>
+    <created_at>2019-06-21 14:49:40 UTC</created_at>
+    <updated_at>2019-06-21 14:49:40 UTC</updated_at>
+    <opted_out_at />
+    <opted_out_source />
+    <source type="API" name="User1" email="user1@domain.com" />
+    <address>
+      <street1 />
+      <street2 />
+      <city />
+      <state />
+      <postal_code />
+      <country>US</country>
+    </address>
+    <last_saved_location>
+      <latitude>38.906639</latitude>
+      <longitude>-77.016577</longitude>
+      <precision>state</precision>
+      <city />
+      <state>DC</state>
+      <postal_code />
+      <country>US</country>
+    </last_saved_location>
+    <custom_columns>
+      <custom_column name="Age" />
+      <custom_column name="Favorite animal" />
+      <custom_column name="Yes/NO" />
+    </custom_columns>
+    <subscriptions>
+      <subscription campaign_id="162xxx" campaign_name="MC_test2" campaign_description="" opt_in_path_id="" status="Active" opt_in_source="User1" created_at="2019-06-21T14:49:40Z" activated_at="2019-06-22T20:24:36Z" opted_out_at="" opt_out_source="" />
+    </subscriptions>
+    <integrations></integrations>
+    <clicks></clicks>
+  </profile>
+</response>

data/spec/group_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe UplandMobileCommonsRest::Groups do
@@ -16,15 +18,55 @@ describe UplandMobileCommonsRest::Groups do
     describe 'list' do
       let(:response_body) { fixture('groups/list.xml') }
 
-      before(:each) do
-        stub_upland_mobile_commons_request('groups', method: :get).to_return(status: 200, body: response_body)
+      context 'unpaginated request' do
+        before(:each) do
+          stub_upland_mobile_commons_request('groups', method: :get).to_return(status: 200, body: response_body)
+        end
+
+        it 'should return a list of groups' do
+          list = subject.list
+          expect(list).to be_a(Enumerable)
+          expect(list).to eq([{ 'id' => '14', 'name' => 'Group One', 'size' => '2', 'status' => 'active', 'type' => 'FilteredGroup' },
+                              { 'id' => '91', 'name' => 'Group Two', 'size' => '1', 'status' => 'active',
+                                'type' => 'UploadedGroup' }])
+        end
       end
 
-      it 'should return a list of groups' do
-        list = subject.list
-        expect(list).to be_a(Enumerable)
-        expect(list).to eq([{"id"=>"14", "name"=>"Group One", "size"=>"2", "status"=>"active", "type"=>"FilteredGroup"},
-                            {"id"=>"91", "name"=>"Group Two", "size"=>"1", "status"=>"active", "type"=>"UploadedGroup"}])
+      context 'paginated request' do
+        it 'should return a list of groups when both parameters provided' do
+          stub_upland_mobile_commons_request('groups?limit=50&page=35', method: :get).to_return(status: 200,
+                                                                                                body: response_body)
+
+          list = subject.list(page: 35, limit: 50)
+
+          expect(list).to be_a(Enumerable)
+          expect(list).to eq([{ 'id' => '14', 'name' => 'Group One', 'size' => '2', 'status' => 'active', 'type' => 'FilteredGroup' },
+                              { 'id' => '91', 'name' => 'Group Two', 'size' => '1', 'status' => 'active',
+                                'type' => 'UploadedGroup' }])
+        end
+
+        it 'should return a list of groups when only limit parameter provided' do
+          stub_upland_mobile_commons_request('groups?limit=50', method: :get).to_return(status: 200,
+                                                                                        body: response_body)
+
+          list = subject.list(limit: 50)
+
+          expect(list).to be_a(Enumerable)
+          expect(list).to eq([{ 'id' => '14', 'name' => 'Group One', 'size' => '2', 'status' => 'active', 'type' => 'FilteredGroup' },
+                              { 'id' => '91', 'name' => 'Group Two', 'size' => '1', 'status' => 'active',
+                                'type' => 'UploadedGroup' }])
+        end
+
+        it 'should return a list of groups when only page parameter provided' do
+          stub_upland_mobile_commons_request('groups?page=35', method: :get).to_return(status: 200, body: response_body)
+
+          list = subject.list(page: 35)
+
+          expect(list).to be_a(Enumerable)
+          expect(list).to eq([{ 'id' => '14', 'name' => 'Group One', 'size' => '2', 'status' => 'active', 'type' => 'FilteredGroup' },
+                              { 'id' => '91', 'name' => 'Group Two', 'size' => '1', 'status' => 'active',
+                                'type' => 'UploadedGroup' }])
+        end
       end
     end
 
@@ -32,7 +74,9 @@ describe UplandMobileCommonsRest::Groups do
       let(:response_body) { fixture('groups/create.xml') }
 
       before(:each) do
-        stub_upland_mobile_commons_request('create_group?name=Chocolate%20Lovers', method: :get).to_return(status: 200, body: response_body)
+        stub_upland_mobile_commons_request('create_group?name=Chocolate%20Lovers', method: :get).to_return(
+          status: 200, body: response_body
+        )
       end
 
       it 'should return success' do
@@ -41,4 +85,4 @@ describe UplandMobileCommonsRest::Groups do
       end
     end
   end
-end
+end

data/spec/profiles_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe UplandMobileCommonsRest::Profiles do
@@ -16,8 +18,8 @@ describe UplandMobileCommonsRest::Profiles do
 
     describe 'get' do
       before(:each) do
-        stub_upland_mobile_commons_request("profile?phone_number=#{phone_number}", method: :get).
-            to_return(status: 200, body: response_body)
+        stub_upland_mobile_commons_request("profile?phone_number=#{phone_number}", method: :get)
+          .to_return(status: 200, body: response_body)
       end
 
       context 'success' do
@@ -45,8 +47,8 @@ describe UplandMobileCommonsRest::Profiles do
 
     describe 'update' do
       before(:each) do
-        stub_upland_mobile_commons_request('profile_update', method: :post, body: "phone_number=#{phone_number}").
-            to_return(status: 200, body: response_body)
+        stub_upland_mobile_commons_request('profile_update', method: :post, body: "phone_number=#{phone_number}")
+          .to_return(status: 200, body: response_body)
       end
 
       context 'success' do
@@ -55,6 +57,10 @@ describe UplandMobileCommonsRest::Profiles do
         it 'should succeed' do
           resp = subject.update(phone_number: phone_number)
           expect(resp).to_not be_nil
+
+          expect(resp.body['response']['profile']['id']).to eq('34xxxxxxx')
+          expect(resp.body['response']['profile']['first_name']).to eq('John')
+          expect(resp.body['response']['profile']['last_name']).to eq('Doe')
         end
       end
 
@@ -62,7 +68,9 @@ describe UplandMobileCommonsRest::Profiles do
         let(:response_body) { fixture('error.xml') }
 
         it 'should raise' do
-          expect { subject.update(phone_number: phone_number) }.to raise_error(UplandMobileCommonsRest::InvalidMessageBody)
+          expect do
+            subject.update(phone_number: phone_number)
+          end.to raise_error(UplandMobileCommonsRest::InvalidMessageBody)
         end
       end
     end

data/spec/spec_helper.rb

@@ -5,11 +5,11 @@ require 'upland_mobile_commons_rest'
 require 'webmock/rspec'
 
 # Require everything in the `support` directory
-Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].sort.each {|f| require f}
+Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].sort.each { |f| require f }
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
+  config.example_status_persistence_file_path = '.rspec_status'
 
   # Disable RSpec exposing methods globally on `Module` and `main`
   config.disable_monkey_patching!
@@ -20,4 +20,4 @@ RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
-end
+end

data/spec/support/fixtures.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def fixture(name)
-  File.read(File.join(File.dirname(__FILE__), '..','fixtures', name))
+  File.read(File.join(File.dirname(__FILE__), '..', 'fixtures', name))
 end

data/spec/support/stub_requests.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 def stub_upland_mobile_commons_request(path, method:, body: nil)
   stub_request(method, "https://secure.mcommons.com/api/#{path}")
-      .with(body: body, basic_auth: [username, password])
+    .with(body: body, basic_auth: [username, password])
 end

data/spec/upland_mobile_commons_rest_spec.rb

@@ -9,4 +9,4 @@ describe UplandMobileCommonsRest do
     expect(client.username).to eq('foo')
     expect(client.password).to eq('bar')
   end
-end
+end

data/upland_mobile_commons_rest.gemspec

@@ -2,29 +2,30 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: upland_mobile_commons_rest 0.1.0 ruby lib
+# stub: upland_mobile_commons_rest 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "upland_mobile_commons_rest".freeze
-  s.version = "0.1.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
-  s.authors = ["Nathan Woodhull".freeze]
-  s.date = "2020-06-25"
+  s.authors = ["Kathy Lu".freeze, "Diego Marcet".freeze, "Grey Moore".freeze, "Nathan Woodhull".freeze]
+  s.date = "2022-07-05"
   s.description = "A simple ruby API client gem for the Upland Mobile Commons REST API".freeze
-  s.email = "nathan@controlshiftlabs.com".freeze
+  s.email = "team@controlshiftlabs.com".freeze
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
   ]
   s.files = [
     ".document",
+    ".github/workflows/ci.yml",
     ".rubocop.yml",
-    ".travis.yml",
+    ".ruby-gemset",
+    ".ruby-version",
     "CODE_OF_CONDUCT.md",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
@@ -41,8 +42,10 @@ Gem::Specification.new do |s|
     "spec/client_spec.rb",
     "spec/fixtures/campaigns/list.xml",
     "spec/fixtures/error.xml",
+    "spec/fixtures/error_profile_not_found.xml",
     "spec/fixtures/groups/create.xml",
     "spec/fixtures/groups/list.xml",
+    "spec/fixtures/profiles/get.xml",
     "spec/fixtures/profiles/update.xml",
     "spec/group_spec.rb",
     "spec/profiles_spec.rb",
@@ -54,48 +57,36 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/controlshift/upland_mobile_commons_rest".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.8".freeze
+  s.rubygems_version = "3.1.6".freeze
   s.summary = "API client gem for Upland Mobile Commons".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<vertebrae>.freeze, [">= 0"])
-      s.add_development_dependency(%q<shoulda>.freeze, [">= 0"])
-      s.add_development_dependency(%q<rdoc>.freeze, ["> 3.12"])
-      s.add_development_dependency(%q<bundler>.freeze, ["> 2.0"])
-      s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
-      s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
-      s.add_development_dependency(%q<dotenv>.freeze, [">= 0"])
-      s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
-      s.add_development_dependency(%q<rubocop>.freeze, [">= 0"])
-      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_development_dependency(%q<webmock>.freeze, [">= 0"])
-    else
-      s.add_dependency(%q<vertebrae>.freeze, [">= 0"])
-      s.add_dependency(%q<shoulda>.freeze, [">= 0"])
-      s.add_dependency(%q<rdoc>.freeze, ["> 3.12"])
-      s.add_dependency(%q<bundler>.freeze, ["> 2.0"])
-      s.add_dependency(%q<juwelier>.freeze, [">= 0"])
-      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
-      s.add_dependency(%q<dotenv>.freeze, [">= 0"])
-      s.add_dependency(%q<byebug>.freeze, [">= 0"])
-      s.add_dependency(%q<rubocop>.freeze, [">= 0"])
-      s.add_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_dependency(%q<webmock>.freeze, [">= 0"])
-    end
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<vertebrae>.freeze, [">= 0"])
+    s.add_development_dependency(%q<bundler>.freeze, ["> 2.0"])
+    s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
+    s.add_development_dependency(%q<dotenv>.freeze, [">= 0"])
+    s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+    s.add_development_dependency(%q<rdoc>.freeze, ["> 3.12"])
+    s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_development_dependency(%q<rubocop>.freeze, [">= 0"])
+    s.add_development_dependency(%q<shoulda>.freeze, [">= 0"])
+    s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_development_dependency(%q<webmock>.freeze, [">= 0"])
   else
     s.add_dependency(%q<vertebrae>.freeze, [">= 0"])
-    s.add_dependency(%q<shoulda>.freeze, [">= 0"])
-    s.add_dependency(%q<rdoc>.freeze, ["> 3.12"])
     s.add_dependency(%q<bundler>.freeze, ["> 2.0"])
-    s.add_dependency(%q<juwelier>.freeze, [">= 0"])
-    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
-    s.add_dependency(%q<dotenv>.freeze, [">= 0"])
     s.add_dependency(%q<byebug>.freeze, [">= 0"])
-    s.add_dependency(%q<rubocop>.freeze, [">= 0"])
+    s.add_dependency(%q<dotenv>.freeze, [">= 0"])
+    s.add_dependency(%q<juwelier>.freeze, [">= 0"])
+    s.add_dependency(%q<rdoc>.freeze, ["> 3.12"])
     s.add_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<rubocop>.freeze, [">= 0"])
+    s.add_dependency(%q<shoulda>.freeze, [">= 0"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
     s.add_dependency(%q<webmock>.freeze, [">= 0"])
   end
 end

metadata

@@ -1,14 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: upland_mobile_commons_rest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
+- Kathy Lu
+- Diego Marcet
+- Grey Moore
 - Nathan Woodhull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -25,47 +28,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: juwelier
   requirement: !ruby/object:Gem::Requirement
@@ -81,21 +84,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +112,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +126,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +140,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +168,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: A simple ruby API client gem for the Upland Mobile Commons REST API
-email: nathan@controlshiftlabs.com
+email: team@controlshiftlabs.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -173,11 +176,12 @@ extra_rdoc_files:
 - README.md
 files:
 - ".document"
+- ".github/workflows/ci.yml"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -194,8 +198,10 @@ files:
 - spec/client_spec.rb
 - spec/fixtures/campaigns/list.xml
 - spec/fixtures/error.xml
+- spec/fixtures/error_profile_not_found.xml
 - spec/fixtures/groups/create.xml
 - spec/fixtures/groups/list.xml
+- spec/fixtures/profiles/get.xml
 - spec/fixtures/profiles/update.xml
 - spec/group_spec.rb
 - spec/profiles_spec.rb
@@ -223,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: API client gem for Upland Mobile Commons

data/.travis.yml

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

data/Gemfile.lock

@@ -1,154 +0,0 @@
-GIT
-  remote: https://github.com/flajann2/juwelier.git
-  revision: de59d5a2ddea00c1f18957ab62129c1c141acce1
-  specs:
-    juwelier (2.4.9)
-      builder
-      bundler
-      git
-      github_api
-      highline
-      kamelcase (~> 0)
-      nokogiri
-      psych
-      rake
-      rdoc
-      semver2
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    builder (3.2.4)
-    byebug (11.1.3)
-    concurrent-ruby (1.1.6)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    dotenv (2.7.5)
-    faraday (0.17.3)
-      multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.14.0)
-      faraday (>= 0.7.4, < 1.0)
-    git (1.7.0)
-      rchardet (~> 1.8)
-    github_api (0.18.2)
-      addressable (~> 2.4)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8)
-      hashie (~> 3.5, >= 3.5.2)
-      oauth2 (~> 1.0)
-    hashdiff (1.0.1)
-    hashie (3.6.0)
-    highline (2.0.3)
-    i18n (1.8.3)
-      concurrent-ruby (~> 1.0)
-    jwt (2.2.1)
-    kamelcase (0.0.2)
-      semver2 (~> 3)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    multi_json (1.14.1)
-    multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    oauth2 (1.4.4)
-      faraday (>= 0.8, < 2.0)
-      jwt (>= 1.0, < 3.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    psych (3.1.0)
-    public_suffix (4.0.5)
-    rack (2.2.3)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rchardet (1.8.0)
-    rdoc (6.2.1)
-    regexp_parser (1.7.0)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.85.0)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.0.3)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    semver2 (3.4.2)
-    shoulda (3.6.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (~> 3.0)
-    shoulda-context (1.2.2)
-    shoulda-matchers (3.1.3)
-      activesupport (>= 4.0.0)
-    simplecov (0.18.5)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    vertebrae (0.6.2)
-      activesupport (>= 5.1.4)
-      faraday (> 0.9.2)
-      faraday_middleware (> 0.12.2)
-      hashie (> 3.5.7)
-    webmock (3.8.3)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (> 2.0)
-  byebug
-  dotenv
-  juwelier!
-  rdoc (> 3.12)
-  rspec
-  rubocop
-  shoulda
-  simplecov
-  vertebrae
-  webmock
-
-BUNDLED WITH
-   2.1.4