upland_mobile_commons_rest 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fea28fb6b44128149d673e0a44a7e709ae20ed9e8df8d23caba96eb61b57ba81
-  data.tar.gz: 438ffc1b50e2bb7b625d67d09201498030e1882e5b6b250f01c37e0221c0de7c
+  metadata.gz: 563dc35fc8c63e68ca7f080f7b965493109dcb77d35905954f4144e5c5e91a93
+  data.tar.gz: 1bcb1cb945614e39418878e6636e7c3ab61fc1f89d3983e07edc083466f16bcc
 SHA512:
-  metadata.gz: de00accf8fd3630b0cee809b05c952f1a51d6b0552c8ec8995b4ccfe99ee35b11555717c3b8be9292fe5906c1e3c5b19e6ab2a03f692aee72f476d84492e68aa
-  data.tar.gz: ce9b7d848838ff6ce8e1508ac3e909d355aa6993d020149ac5d1706a4491d5ac973ec292c7226472569fe6fb58c48aa1b3de4c57e24b10a78e10be0e9c26826f
+  metadata.gz: a81440d9f63e8c4b000751fc6628771b690e4d0736edb406ec4550c35c29ff82ea89bd37741882c5982c6c4aef60a85a1dba8dd9d0bd385ab6c8ef645c3ad1eb
+  data.tar.gz: 6d4437e6f038188d134dfee9e576158ec390304a6061b5ce0cf912d07ba4b858b2b1d1030bcf40e037f1cc50e26b4d9864552cf4981766f917e7afa9c15c32d5

data/Gemfile.lock

@@ -75,7 +75,7 @@ GEM
       ast (~> 2.4.0)
     psych (3.1.0)
     public_suffix (4.0.5)
-    rack (2.2.2)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
     rchardet (1.8.0)

data/README.md

@@ -1,7 +1,7 @@
 # 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. 
+A ruby gem for interacting with the Upland Mobile Commons API.
 
 ## Usage
 
@@ -15,5 +15,8 @@ client.groups.create('Chocolate Lovers')
 
 # create/update a profile
 client.profiles.update(phone_number: '123-456-7890')
+
+# retrieve a profile by its phone number
+client.profiles.get('123-456-7890')
 ```
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/upland_mobile_commons_rest/profiles.rb

@@ -1,8 +1,19 @@
 module UplandMobileCommonsRest
   class Profiles < Base
+    def base_path
+      'profile'
+    end
+
+    def get(phone_number)
+      resp = client.get_request("#{base_path}?phone_number=#{CGI.escape(phone_number)}")
+      resp.body['response']['profile']
+    # API returns error id '5' (invalid phone number) when profile with phone number is not found
+    rescue UplandMobileCommonsRest::InvalidPhoneNumber
+      nil
+    end
 
     def update(params)
       client.post_request('profile_update', params)
     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/profiles_spec.rb

@@ -12,10 +12,40 @@ describe UplandMobileCommonsRest::Profiles do
   context 'with credentials' do
     let(:username) { 'username' }
     let(:password) { 'password' }
+    let(:phone_number) { '123-256-7890' }
+
+    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)
+      end
+
+      context 'success' do
+        let(:response_body) { fixture('profiles/get.xml') }
+
+        it 'should return profile data' do
+          resp = subject.get(phone_number)
+          expect(resp).to_not be_nil
+          expect(resp['first_name']).to eq('John')
+          expect(resp['last_name']).to eq('Doe')
+          expect(resp['phone_number']).to eq('12025551234')
+          expect(resp['id']).to eq('34xxxxxxx')
+        end
+      end
+
+      context 'error' do
+        let(:response_body) { fixture('error_profile_not_found.xml') }
+
+        it 'should return nil and not raise' do
+          resp = subject.get(phone_number)
+          expect(resp).to be_nil
+        end
+      end
+    end
 
     describe 'update' do
       before(:each) do
-        stub_upland_mobile_commons_request('profile_update', method: :post, body: 'phone_number=123-256-7890').
+        stub_upland_mobile_commons_request('profile_update', method: :post, body: "phone_number=#{phone_number}").
             to_return(status: 200, body: response_body)
       end
 
@@ -23,7 +53,7 @@ describe UplandMobileCommonsRest::Profiles do
         let(:response_body) { fixture('profiles/update.xml') }
 
         it 'should succeed' do
-          resp = subject.update(phone_number: '123-256-7890')
+          resp = subject.update(phone_number: phone_number)
           expect(resp).to_not be_nil
         end
       end
@@ -32,7 +62,7 @@ describe UplandMobileCommonsRest::Profiles do
         let(:response_body) { fixture('error.xml') }
 
         it 'should raise' do
-          expect { subject.update(phone_number: '123-256-7890') }.to raise_error(UplandMobileCommonsRest::InvalidMessageBody)
+          expect { subject.update(phone_number: phone_number) }.to raise_error(UplandMobileCommonsRest::InvalidMessageBody)
         end
       end
     end

data/upland_mobile_commons_rest.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: upland_mobile_commons_rest 0.0.1 ruby lib
+# stub: upland_mobile_commons_rest 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "upland_mobile_commons_rest".freeze
-  s.version = "0.0.1"
+  s.version = "0.1.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-09"
+  s.date = "2020-06-25"
   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 = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upland_mobile_commons_rest
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Nathan Woodhull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -194,8 +194,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