upland_mobile_commons_rest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fea28fb6b44128149d673e0a44a7e709ae20ed9e8df8d23caba96eb61b57ba81
+  data.tar.gz: 438ffc1b50e2bb7b625d67d09201498030e1882e5b6b250f01c37e0221c0de7c
+SHA512:
+  metadata.gz: de00accf8fd3630b0cee809b05c952f1a51d6b0552c8ec8995b4ccfe99ee35b11555717c3b8be9292fe5906c1e3c5b19e6ab2a03f692aee72f476d84492e68aa
+  data.tar.gz: ce9b7d848838ff6ce8e1508ac3e909d355aa6993d020149ac5d1706a4491d5ac973ec292c7226472569fe6fb58c48aa1b3de4c57e24b10a78e10be0e9c26826f

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

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/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,21 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+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"
+end

data/Gemfile.lock

@@ -0,0 +1,154 @@
+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.2)
+    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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2020 ChangeSprout, Inc.
+
+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,19 @@
+# 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)
+
+A ruby gem for interacting with the Upland Mobile Commons API. 
+
+## Usage
+
+```ruby
+client = UplandMobileCommonsRest.new(username: 'user', password: 'password')
+# List Campaigns
+client.campaigns.list
+
+# create a group
+client.groups.create('Chocolate Lovers')
+
+# create/update a profile
+client.profiles.update(phone_number: '123-456-7890')
+```
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "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"]
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "upland_mobile_commons_rest #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/example.rb

@@ -0,0 +1,15 @@
+  
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+
+require 'upland_mobile_commons_rest'
+require 'dotenv'
+require 'byebug'
+
+Dotenv.load('.env')
+
+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!"

data/lib/upland_mobile_commons_rest.rb

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

data/lib/upland_mobile_commons_rest/base.rb

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,13 @@
+module UplandMobileCommonsRest
+  class Campaigns < Base
+
+    def base_path
+      'campaigns'
+    end
+
+    def list
+      resp = client.get_request(base_path)
+      resp.body['response']['campaigns']['campaign']
+    end
+  end
+end

data/lib/upland_mobile_commons_rest/client.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module UplandMobileCommonsRest
+  class Client < Vertebrae::API
+    attr_accessor :username, :password, :company_key
+
+    def initialize(options={}, &block)
+      self.username = options[:username]
+      self.password = options[:password]
+      self.company_key = options[:company_key]
+      super(options, &block)
+    end
+
+    def default_options
+      {
+        host: 'secure.mcommons.com',
+        prefix: '/api',
+        user_agent: 'ruby: UplandMobileCommonsRest',
+        content_type: 'application/x-www-form-urlencoded',
+        additional_headers: {
+          'Accept' => 'application/xml'
+        }
+      }
+    end
+
+    def setup
+      connection.stack do |builder|
+        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
+        end
+
+        builder.use UplandMobileCommonsRest::TypedErrorMiddleware
+        builder.use Faraday::Response::Logger if ENV['DEBUG']
+        builder.use FaradayMiddleware::ParseXml
+
+        builder.adapter connection.configuration.adapter
+      end
+    end
+
+    def extract_data_from_params(params) # :nodoc:
+      URI.encode_www_form(params)
+    end
+
+    ## Helper functions to let consumers do things like `client.campaigns.list`
+
+    def campaigns
+      @_campaigns ||= UplandMobileCommonsRest::Campaigns.new(client: self)
+    end
+
+    def groups
+      @_groups ||= UplandMobileCommonsRest::Groups.new(client: self)
+    end
+
+    def profiles
+      @_profiles ||= UplandMobileCommonsRest::Profiles.new(client: self)
+    end
+  end
+end

data/lib/upland_mobile_commons_rest/errors.rb

@@ -0,0 +1,93 @@
+module UplandMobileCommonsRest
+  class MobileCommonsError < StandardError
+    attr_accessor :code, :raw_message
+  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
+
+  class TypedErrorMiddleware < Faraday::Response::Middleware
+    POSSIBLE_ERRORS = {
+      '0' => UnknownError,
+      '1' => InvalidCampaignId,
+      '2' => InvalidBroadcastTime,
+      '3' => InvalidMessageBody,
+      '4' => InvalidCompanyId,
+      '5' => InvalidPhoneNumber,
+      '6' => InvalidGroupId,
+      '7' => InvalidStartTime,
+      '8' => InvalidEndTime,
+      '9' => InvalidMdataId,
+      '10' => InvalidKey,
+      '11' => PhoneIsNotOptedIntoThisCampaign,
+      '12' => InvalidFundraisingId,
+      '13' => InvalidMessageTemplate,
+      '14' => PhoneIsNotTextable,
+      '15' => InvalidMconnectId,
+      '16' => InvalidQueryParameters,
+      '17' => TooManyMessages,
+      '18' => InvalidName,
+      '19' => InvalidOptInPath,
+      '20' => InvalidUrl,
+      '21' => InvalidAttachment,
+      '22' => InvalidBroadcastId,
+      '23' => InvalidBroadcastStateChange,
+      '24' => BroadcastHasNotBeenSent,
+      '25' => MessageTemplateInvalid,
+      '26' => InvalidUserId,
+      '27' => APIRateLimitExceeded,
+      '28' => MissingPhoneNumberParameter,
+      '29' => InvalidProfileSaveItemBehavior,
+      '30' => InvalidProfileAttributes,
+      '31' => InvalidPreviousId,
+      '32' => InvalidTagName,
+      '33' => InvalidTagParameters,
+      '34' => InvalidShortcodeId,
+      '35' => InvalidDateRange,
+      '36' => InvalidScheduledMessageId,
+      '37' => MessageHasAlreadyBeenSent
+    }
+
+    def on_complete(response)
+      if response.body['response']['success'] == 'false'
+        raise POSSIBLE_ERRORS[response.body['response']['error']['id']].new(response.body['response']['error']['message'])
+      end
+    end
+  end
+end

data/lib/upland_mobile_commons_rest/groups.rb

@@ -0,0 +1,27 @@
+module UplandMobileCommonsRest
+  class Groups < Base
+
+    def base_path
+      'groups'
+    end
+
+    def list
+      resp = client.get_request(base_path)
+      resp.body['response']['groups']['group']
+    end
+
+    def create(name)
+      client.get_request("create_group?name=#{url_escape(name)}")
+    end
+
+    def add_member(group_id, phone_numbers)
+      phone_number_argument = if phone_numbers.is_a?(Array)
+                                phone_numbers.join(',')
+                              else
+                                phone_numbers
+                              end
+
+      client.get_request("add_group_member?group_id=#{url_escape(group_id)}&phone_number=#{url_escape(phone_number_argument)}")
+    end
+  end
+end

data/lib/upland_mobile_commons_rest/profiles.rb

@@ -0,0 +1,8 @@
+module UplandMobileCommonsRest
+  class Profiles < Base
+
+    def update(params)
+      client.post_request('profile_update', params)
+    end
+  end
+end

data/spec/campaigns_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe UplandMobileCommonsRest::Campaigns do
+  let(:client) { UplandMobileCommonsRest::Client.new(username: 'username', password: 'password') }
+
+  subject { UplandMobileCommonsRest::Campaigns.new(client: client) }
+
+  it 'should initialize' do
+    expect(subject.client).to eq(client)
+  end
+
+  context 'with credentials' do
+    let(:username) { 'username' }
+    let(:password) { 'password' }
+
+    describe 'list' do
+      let(:response_body) { fixture('campaigns/list.xml') }
+
+      before(:each) do
+        stub_upland_mobile_commons_request('campaigns', method: :get).to_return(status: 200, body: response_body)
+      end
+
+      it 'should return a list of campaigns' do
+        list = subject.list
+        expect(list).to be_a(Enumerable)
+      end
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe UplandMobileCommonsRest::Client do
+  describe 'default_options' do
+    it 'should set some defaults' do
+      expect(subject.default_options[:user_agent]).to match(/ruby/)
+      expect(subject.default_options[:host]).to eq('secure.mcommons.com')
+    end
+  end
+
+  describe 'helpers' do
+    it 'should return campaigns helper' do
+      campaigns = subject.campaigns
+      expect(campaigns).to be_a(UplandMobileCommonsRest::Campaigns)
+      expect(campaigns.client).to eq(subject)
+    end
+  end
+end

data/spec/fixtures/campaigns/list.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response success="true">
+  <campaigns>
+    <campaign id="303" active="false">
+      <name>Campaign One</name>
+      <description></description>
+      <tags>
+        <tag>Tag Name Here</tag>
+      </tags>
+      <opt_in_paths>
+      <opt_in_path id="175057" active = "true">
+        <name>My Opt-In Path</name>
+        <tags>
+          <tag>OIP ABC</tag>
+        </tags>
+      </opt_in_path>
+      </opt_in_paths>
+    </campaign>
+    <campaign id="304" active="false">
+      <name>Huge Campaign</name>
+      <description></description>
+      <tags>
+        <tag>Tag Name Here</tag>
+      </tags>
+    </campaign>
+    <campaign id="305" active="true">
+      <name>Another Campaign</name>
+      <description>Campaign to end all campaigns</description>
+      <tags>
+        <tag>Tag Name Here</tag>
+      </tags>
+    </campaign>
+  </campaigns>
+</response>

data/spec/fixtures/error.xml

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

data/spec/fixtures/groups/create.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response success="true">
+  <group id="3" type="UploadedGroup" name="Chocolate Lovers"></group>
+</response>

data/spec/fixtures/groups/list.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response success="true">
+  <groups>
+    <group id="14" type="FilteredGroup" status="active">
+      <name>Group One</name>
+      <size>2</size>
+    </group>
+    <group id="91" type="UploadedGroup" status="active">
+      <name>Group Two</name>
+      <size>1</size>
+    </group>
+  </groups>
+</response>

data/spec/fixtures/profiles/update.xml

@@ -0,0 +1,44 @@
+<?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

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe UplandMobileCommonsRest::Groups do
+  let(:client) { UplandMobileCommonsRest::Client.new(username: 'username', password: 'password') }
+
+  subject { UplandMobileCommonsRest::Groups.new(client: client) }
+
+  it 'should initialize' do
+    expect(subject.client).to eq(client)
+  end
+
+  context 'with credentials' do
+    let(:username) { 'username' }
+    let(:password) { 'password' }
+
+    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)
+      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
+
+    describe 'create' 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)
+      end
+
+      it 'should return success' do
+        resp = subject.create('Chocolate Lovers')
+        expect(resp.body['response']['success']).to be_truthy
+      end
+    end
+  end
+end

data/spec/profiles_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe UplandMobileCommonsRest::Profiles do
+  let(:client) { UplandMobileCommonsRest::Client.new(username: 'username', password: 'password') }
+
+  subject { UplandMobileCommonsRest::Profiles.new(client: client) }
+
+  it 'should initialize' do
+    expect(subject.client).to eq(client)
+  end
+
+  context 'with credentials' do
+    let(:username) { 'username' }
+    let(:password) { 'password' }
+
+    describe 'update' do
+      before(:each) do
+        stub_upland_mobile_commons_request('profile_update', method: :post, body: 'phone_number=123-256-7890').
+            to_return(status: 200, body: response_body)
+      end
+
+      context 'success' do
+        let(:response_body) { fixture('profiles/update.xml') }
+
+        it 'should succeed' do
+          resp = subject.update(phone_number: '123-256-7890')
+          expect(resp).to_not be_nil
+        end
+      end
+
+      context 'error' do
+        let(:response_body) { fixture('error.xml') }
+
+        it 'should raise' do
+          expect { subject.update(phone_number: '123-256-7890') }.to raise_error(UplandMobileCommonsRest::InvalidMessageBody)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+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}
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  # Allow us to say 'describe Foo' instead of 'RSpec.describe Foo'
+  config.expose_dsl_globally = true
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/fixtures.rb

@@ -0,0 +1,3 @@
+def fixture(name)
+  File.read(File.join(File.dirname(__FILE__), '..','fixtures', name))
+end

data/spec/support/stub_requests.rb

@@ -0,0 +1,4 @@
+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])
+end

data/spec/upland_mobile_commons_rest_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe UplandMobileCommonsRest do
+  it 'returns a client' do
+    client = UplandMobileCommonsRest.new(username: 'foo', password: 'bar')
+    expect(client).to be_an_instance_of(UplandMobileCommonsRest::Client)
+    expect(client.username).to eq('foo')
+    expect(client.password).to eq('bar')
+  end
+end

data/upland_mobile_commons_rest.gemspec

@@ -0,0 +1,102 @@
+# Generated by juwelier
+# 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.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "upland_mobile_commons_rest".freeze
+  s.version = "0.0.1"
+
+  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-09"
+  s.description = "A simple ruby API client gem for the Upland Mobile Commons REST API".freeze
+  s.email = "nathan@controlshiftlabs.com".freeze
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rubocop.yml",
+    ".travis.yml",
+    "CODE_OF_CONDUCT.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "example.rb",
+    "lib/upland_mobile_commons_rest.rb",
+    "lib/upland_mobile_commons_rest/base.rb",
+    "lib/upland_mobile_commons_rest/campaigns.rb",
+    "lib/upland_mobile_commons_rest/client.rb",
+    "lib/upland_mobile_commons_rest/errors.rb",
+    "lib/upland_mobile_commons_rest/groups.rb",
+    "lib/upland_mobile_commons_rest/profiles.rb",
+    "spec/campaigns_spec.rb",
+    "spec/client_spec.rb",
+    "spec/fixtures/campaigns/list.xml",
+    "spec/fixtures/error.xml",
+    "spec/fixtures/groups/create.xml",
+    "spec/fixtures/groups/list.xml",
+    "spec/fixtures/profiles/update.xml",
+    "spec/group_spec.rb",
+    "spec/profiles_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/fixtures.rb",
+    "spec/support/stub_requests.rb",
+    "spec/upland_mobile_commons_rest_spec.rb",
+    "upland_mobile_commons_rest.gemspec"
+  ]
+  s.homepage = "http://github.com/controlshift/upland_mobile_commons_rest".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.0.8".freeze
+  s.summary = "API client gem for Upland Mobile Commons".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    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
+  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
+end
+

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: upland_mobile_commons_rest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Woodhull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vertebrae
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  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: simplecov
+  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: 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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: webmock
+  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: A simple ruby API client gem for the Upland Mobile Commons REST API
+email: nathan@controlshiftlabs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- example.rb
+- lib/upland_mobile_commons_rest.rb
+- lib/upland_mobile_commons_rest/base.rb
+- lib/upland_mobile_commons_rest/campaigns.rb
+- lib/upland_mobile_commons_rest/client.rb
+- lib/upland_mobile_commons_rest/errors.rb
+- lib/upland_mobile_commons_rest/groups.rb
+- lib/upland_mobile_commons_rest/profiles.rb
+- spec/campaigns_spec.rb
+- spec/client_spec.rb
+- spec/fixtures/campaigns/list.xml
+- spec/fixtures/error.xml
+- spec/fixtures/groups/create.xml
+- spec/fixtures/groups/list.xml
+- spec/fixtures/profiles/update.xml
+- spec/group_spec.rb
+- spec/profiles_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures.rb
+- spec/support/stub_requests.rb
+- spec/upland_mobile_commons_rest_spec.rb
+- upland_mobile_commons_rest.gemspec
+homepage: http://github.com/controlshift/upland_mobile_commons_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.0.8
+signing_key: 
+specification_version: 4
+summary: API client gem for Upland Mobile Commons
+test_files: []