revere_mobile 0.1.0

data/spec/revere_mobile/client/campaign_spec.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module RevereMobile
+  class Client
+    RSpec.describe Campaign do
+      let(:client) { RevereMobile::Client.new }
+
+      describe '#campaigns' do
+        let(:params) { Hash.new }
+        let(:response) { fixture('campaigns/get_all_campaigns.json') }
+        let(:url) { build_url(client: client, path: 'campaign') }
+
+        before do
+          stub_request(:get, url)
+            .with(query: params)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.campaigns(params: params)
+          expect(
+            a_request(:get, url)
+              .with(query: params)
+          ).to have_been_made
+        end
+
+        it 'returns the campaigns' do
+          campaigns = client.campaigns(
+            params: params)
+          expect(campaigns['collection']).to be_a(Array)
+        end
+
+        it 'returns the campaigns with details' do
+          campaigns = client.campaigns(
+            params: params)
+          campaign = campaigns['collection'].first
+          expect(campaign['id']).not_to be_empty
+          expect(campaign['account']).not_to be_empty
+        end
+      end
+
+      describe '#create_campaign' do
+        let(:params) { Hash.new name: 'Test Campaign' }
+        let(:response) { fixture('campaigns/create_campaign.json') }
+        let(:url) { build_url(client: client, path: 'campaign') }
+
+        before do
+          stub_request(:post, url)
+            .with(body: params)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.create_campaign(params)
+          expect(
+            a_request(:post, url)
+              .with(body: params)
+          ).to have_been_made
+        end
+
+        it 'returns the created campaign' do
+          campaign = client.create_campaign(params)
+          expect(campaign['id']).not_to be_empty
+          expect(campaign['name']).to eq('Test Campaign')
+          expect(campaign['startDate']).not_to be_empty
+          expect(campaign['mobileFlows']).to be_a(Array)
+        end
+      end
+      describe '#update_campaign' do
+        let(:params) { { id: '5493568f0cb2fcad2e35ecb5', name: 'Test Campaign' } }
+        let(:url) { build_url(client: client, path: 'campaign/5493568f0cb2fcad2e35ecb5') }
+
+        before do
+          stub_request(:put, url)
+            .with(body: params)
+            .to_return(
+              status: 204
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.update_campaign(params)
+          expect(
+            a_request(:put, url)
+              .with(body: params)
+          ).to have_been_made
+        end
+
+        it 'returns with with an empty string' do
+          # Revere Mobile comes back with No Content here
+          response = client.update_campaign(params)
+          expect(
+            response
+          ).to eq('')
+        end
+      end
+    end
+  end
+end

data/spec/revere_mobile/client/mobile_flow_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module RevereMobile
+  class Client
+    RSpec.describe MobileFlow do
+      let(:client) { RevereMobile::Client.new }
+
+      describe "#mobileflows" do
+        let(:params) { Hash.new }
+        let(:response) { fixture('mobile_flows/get_all_mobile_flows.json') }
+        let(:url) { build_url(client: client, path: 'mobileflow') }
+
+        before do
+          stub_request(:get, url)
+            .with(query: params)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.mobileflows(params: params)
+          expect(
+            a_request(:get, url)
+              .with(query: params)
+          ).to have_been_made
+        end
+
+        it 'returns the mobileflows' do
+          mobileflows = client.mobileflows(
+            params: params)
+          expect(mobileflows['collection']).to be_a(Array)
+        end
+
+        it 'returns the mobileflows with details' do
+          mobileflows = client.mobileflows(
+            params: params)
+          mobileflow = mobileflows['collection'].first
+          expect(mobileflow['id']).not_to be_empty
+          expect(mobileflow['campaign']).not_to be_empty
+          expect(mobileflow['shortCode']).not_to be_empty
+          expect(mobileflow['name']).not_to be_empty
+          expect(mobileflow['lists']).not_to be_empty
+          expect(mobileflow['lists']).to be_a(Array)
+        end
+      end
+    end
+  end
+end

data/spec/revere_mobile/client/shortcode_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module RevereMobile
+  class Client
+    RSpec.describe Shortcode do
+      let(:client) { RevereMobile::Client.new }
+
+      describe "#shortcodes" do
+        let(:params) { Hash.new }
+        let(:response) { fixture('shortcodes/get_all_shortcodes.json') }
+        let(:url) { build_url(client: client, path: 'shortcode') }
+
+        before do
+          stub_request(:get, url)
+            .with(query: params)
+            .to_return(
+              body: response
+            )
+        end
+
+        it 'requests the correct resource' do
+          client.shortcodes(params: params)
+          expect(
+            a_request(:get, url)
+              .with(query: params)
+          ).to have_been_made
+        end
+
+        it 'returns the shortcodes' do
+          shortcodes = client.shortcodes(
+            params: params)
+          expect(shortcodes['collection']).to be_a(Array)
+        end
+
+        it 'returns the shortcodes with details' do
+          shortcodes = client.shortcodes(
+            params: params)
+          shortcode = shortcodes['collection'].first
+          expect(shortcode['id']).not_to be_empty
+          expect(shortcode['country']).not_to be_empty
+          expect(shortcode['status']).not_to be_empty
+          expect(shortcode['shortcode']).not_to be_empty
+        end
+      end
+    end
+  end
+end

data/spec/revere_mobile/client_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module RevereMobile
+  RSpec.describe Client do
+    describe 'initialization' do
+      describe 'with a specified configuration' do
+        let(:config) { RevereMobile::Configuration.new }
+
+        subject { RevereMobile::Client.new(config) }
+
+        it 'should accept and store as config' do
+          expect(subject.config).to eq(config)
+        end
+      end
+
+      describe 'without a specified configuration' do
+        it 'should get the default' do
+          expect(subject.config).to eq(RevereMobile.configuration)
+        end
+      end
+    end
+
+    describe 'useage' do
+      it 'should be possible to a config and use it with the client' do
+        configuration = RevereMobile::Configuration.new
+        configuration.user_agent = 'Test Agent'
+        configuration.username = 'Test Username'
+        client = RevereMobile::Client.new(configuration)
+        expect(client.config.user_agent).to eq('Test Agent')
+        expect(client.config.username).to eq('Test Username')
+      end
+    end
+  end
+end

data/spec/revere_mobile/configuration_spec.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module RevereMobile
+  RSpec.describe Configuration do
+    before(:each) { RevereMobile.configuration.reset! }
+    after(:each) { RevereMobile.configuration.reset! }
+
+    describe '#api_endpoint' do
+      context 'when no api_endpoint is specified' do
+        it 'sets a default value' do
+          expect(RevereMobile.configuration.api_endpoint)
+            .to eq(RevereMobile::Default.api_endpoint)
+        end
+      end
+
+      context 'when a custom value is supplied' do
+        let(:url) { Faker::Internet.url }
+
+        before do
+          RevereMobile.configure do |config|
+            config.api_endpoint = url
+          end
+        end
+
+        it 'returns the custom value' do
+          expect(RevereMobile.configuration.api_endpoint).to eq(url)
+        end
+      end
+    end
+
+    describe '#username' do
+      context 'when no username is specified' do
+        it 'sets a default value' do
+          expect(RevereMobile.configuration.username)
+            .to eq(RevereMobile::Default.username)
+        end
+      end
+
+      context 'when a custom value is supplied' do
+        let(:username) { Faker::Internet.username }
+
+        before do
+          RevereMobile.configure do |config|
+            config.username = username
+          end
+        end
+
+        it 'returns the custom value' do
+          expect(RevereMobile.configuration.username).to eq(username)
+        end
+      end
+    end
+
+    describe '#user_agent' do
+      context 'when no user_agent is specified' do
+        it 'sets a default value' do
+          expect(RevereMobile.configuration.user_agent)
+            .to eq(RevereMobile::Default.user_agent)
+        end
+      end
+
+      context 'when a custom value is supplied' do
+        let(:user_agent) { Faker::Internet.user_agent }
+
+        before do
+          RevereMobile.configure do |config|
+            config.user_agent = user_agent
+          end
+        end
+
+        it 'returns the custom value' do
+          expect(RevereMobile.configuration.user_agent).to eq(user_agent)
+        end
+      end
+    end
+
+    describe '#shortcode_id' do
+      context 'when no shortcode_id is specified' do
+        it 'sets a default value' do
+          expect(RevereMobile.configuration.shortcode_id)
+            .to eq(RevereMobile::Default.shortcode_id)
+        end
+      end
+
+      context 'when a custom value is supplied' do
+        let(:shortcode_id) { Faker::Crypto.md5 }
+
+        before do
+          RevereMobile.configure do |config|
+            config.shortcode_id = shortcode_id
+          end
+        end
+
+        it 'returns the custom value' do
+          expect(RevereMobile.configuration.shortcode_id).to eq(shortcode_id)
+        end
+      end
+    end
+
+    describe "#query_size" do
+      context 'when no query_size is specified' do
+        it 'sets a default value' do
+          expect(RevereMobile.configuration.query_size)
+            .to eq(RevereMobile::Default.query_size)
+        end
+      end
+
+      context 'when a custom value is supplied' do
+        let(:query_size) { Faker::Number.between(1, 10) }
+
+        before do
+          RevereMobile.configure do |config|
+            config.query_size = query_size
+          end
+        end
+
+        it 'returns the custom value' do
+          expect(RevereMobile.configuration.query_size).to eq(query_size)
+        end
+      end
+    end
+
+
+    describe '#inspect' do
+      it 'masks the password' do
+        password = Faker::Internet.password
+        RevereMobile.configuration.password = password
+        expect(RevereMobile.configuration.inspect).to_not include(password)
+      end
+
+      it 'masks the api_key' do
+        api_key = Faker::Internet.password
+        RevereMobile.configuration.api_key = api_key
+        expect(RevereMobile.configuration.inspect).to_not include(api_key)
+      end
+    end
+  end
+end

data/spec/revere_mobile/errors_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module RevereMobile
+  RSpec.describe RevereMobile::Error do
+    let(:client) { RevereMobile::Client.new }
+
+    context 'when a resource is not found' do
+      let(:url) { build_url(client: client, path: '/nowhere') }
+
+      before do
+        stub_request(:get, url)
+        .to_return(status: 404)
+      end
+
+      it 'rasies the RevereMobile::NotFound' do
+        expect {
+          client.get(path: '/nowhere')
+        }.to raise_error(RevereMobile::NotFound)
+      end
+    end
+
+    context 'when a bad request is made' do
+      let(:url) { build_url(client: client, path: '/badrequest') }
+
+      before do
+        stub_request(:get, url)
+        .to_return(status: 400)
+      end
+
+      it 'rasies the RevereMobile::BadRequest' do
+        expect {
+          client.get(path: '/badrequest')
+        }.to raise_error(RevereMobile::BadRequest)
+      end
+    end
+
+    context 'when an unkown bad request is made' do
+      let(:url) { build_url(client: client, path: '/badrequest') }
+
+      before do
+        stub_request(:get, url)
+        .to_return(status: 455)
+      end
+
+      it 'rasies the RevereMobile::ClientError' do
+        expect {
+          client.get(path: '/badrequest')
+        }.to raise_error(RevereMobile::ClientError)
+      end
+    end
+
+    context 'when a server error ocurs' do
+      let(:url) { build_url(client: client, path: '/serverError') }
+
+      before do
+        stub_request(:get, url)
+        .to_return(status: 500)
+      end
+
+      it 'rasies the RevereMobile::InternalServerError' do
+        expect {
+          client.get(path: '/serverError')
+        }.to raise_error(RevereMobile::InternalServerError)
+      end
+    end
+
+    context 'when an unknown server error ocurs' do
+      let(:url) { build_url(client: client, path: '/serverError') }
+
+      before do
+        stub_request(:get, url)
+        .to_return(status: 555)
+      end
+
+      it 'rasies the RevereMobile::ServerError' do
+        expect {
+          client.get(path: '/serverError')
+        }.to raise_error(RevereMobile::ServerError)
+      end
+    end
+  end
+end

data/spec/revere_mobile/request_spec.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module RevereMobile
+  RSpec.describe Request do
+    let(:client) { RevereMobile::Client.new }
+    let(:params) { { id: 1 } }
+
+    describe '#get' do
+      let(:url) { build_url(client: client, path: '/mobile/resource') }
+
+      context 'when making a request' do
+        before do
+          stub_request(:get, url)
+        end
+
+        it 'makes a get request' do
+          RevereMobile.get(path:'/mobile/resource')
+          expect(a_request(:get, url)).to have_been_made
+        end
+      end
+
+      context 'when passing parameters to the request' do
+        before do
+          stub_request(:get, url).with(query: params)
+        end
+
+        it 'passes params with the request' do
+          RevereMobile.get(path: '/mobile/resource', params: params)
+          expect(a_request(:get, url).with(query: params)).to have_been_made
+        end
+      end
+    end
+
+    describe '#post' do
+      let(:url) { build_url(client: client, path: '/some/resource') }
+      let(:body) do
+        {
+          username: 'Test Username',
+          password: 'Test Password',
+        }
+      end
+
+      context 'when making a request' do
+        before do
+          stub_request(:post, url)
+        end
+
+        it 'makes a post request' do
+          RevereMobile.post(path: '/some/resource')
+          expect(a_request(:post, url)).to have_been_made
+        end
+      end
+
+      context 'when passing a body to the request' do
+        before do
+          stub_request(:post, url).with(body: JSON.generate(body))
+        end
+
+        it 'makes a post request with a body' do
+          RevereMobile.post(path: '/some/resource', body: body)
+          expect(a_request(:post, url).with(body: body)).to have_been_made
+        end
+      end
+    end
+
+    describe '#put' do
+      let(:url) { build_url(client: client, path: '/some/resource') }
+      let(:body) do
+        {
+          name: 'Test List'
+        }
+      end
+
+      context 'when making a put request' do
+        before do
+          stub_request(:put, url)
+        end
+
+        it 'makes a put request' do
+          RevereMobile.put(path: '/some/resource')
+          expect(a_request(:put, url)).to have_been_made
+        end
+      end
+
+      context 'when making a put request with a body' do
+        before do
+          stub_request(:put, url).with(body: JSON.generate(body))
+        end
+
+        it 'makes a put request with the body' do
+          RevereMobile.put(path: '/some/resource', body: body)
+          expect(a_request(:put, url).with(body: body)).to have_been_made
+        end
+      end
+    end
+
+    context '#delete' do
+      let(:url) { build_url(client: client, path: '/mobile/resource') }
+
+      context 'when making a request' do
+        before do
+          stub_request(:delete, url)
+        end
+
+        it 'makes a get request' do
+          RevereMobile.delete(path:'/mobile/resource')
+          expect(a_request(:delete, url)).to have_been_made
+        end
+      end
+
+      context 'when passing parameters to the request' do
+        before do
+          stub_request(:delete, url).with(query: params)
+        end
+
+        it 'passes params with the request' do
+          RevereMobile.delete(path: '/mobile/resource', params: params)
+          expect(a_request(:delete, url).with(query: params)).to have_been_made
+        end
+      end
+    end
+  end
+end

data/spec/revere_mobile/revere_mobile_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "RevereMobile" do
+  it 'has a version number equal to 0.1.0' do
+    expect(RevereMobile::VERSION).to_not be nil
+    expect(RevereMobile::VERSION).to eq('0.1.0')
+  end
+
+  describe ".client" do
+    it 'creates a new RevereMobile client' do
+      expect(RevereMobile.client).to be_instance_of(RevereMobile::Client)
+    end
+
+    context 'when @client has been already assigned' do
+      it 'returns the @client' do
+        client = RevereMobile.client
+        expect(RevereMobile.client).to eq(client)
+      end
+    end
+  end
+end

data/spec/revere_mobile/support/fixtures/campaigns/create_campaign.json

@@ -0,0 +1,11 @@
+{
+  "account": "546239d10cf25fdcf0aea9b2",
+  "endDate": null,
+  "group": "54623a230cf25fdcf0zeaa5c",
+  "id": "5493568f0cb2fcad2e35ecb5",
+  "mobileFlows": [],
+  "name": "Test Campaign",
+  "shortCode": "515b0768cw10e4ec580fcc60",
+  "startDate": "Fri Jan 01 10:00:00 PDT 2018",
+  "status": "ACTIVE"
+}

data/spec/revere_mobile/support/fixtures/campaigns/get_all_campaigns.json

@@ -0,0 +1,49 @@
+{
+  "page": 1,
+  "size": -1,
+  "total": 3,
+  "collection": [
+    {
+      "id": "570e19afe4b0fddd97d6754f",
+      "account": "416fa6177a475eefd68fb5ef",
+      "group": "4e6fa6187a475eefd68fb5f4",
+      "shortCode": "4e8b4b5afda5efeeec370e8a",
+      "name": "Test Campaign",
+      "startDate": "Wed Apr 13 11:02:23 PDT 2016",
+      "endDate": "Wed Apr 13 11:02:23 PDT 2017",
+      "status": "ACTIVE",
+      "mobileFlows": []
+    },
+    {
+      "id": "56ccdc90e4b087593e734bca",
+      "account": "4e6fa6177a475eefd68fb5ef",
+      "group": "56ccdbb9e4b087593e734b23",
+      "shortCode": "4e8b4b5afdn5efeeec370e8a",
+      "name": "Another Test Campaign",
+      "startDate": "Tue Feb 23 14:26:24 PST 2016",
+      "endDate": null,
+      "status": "ACTIVE",
+      "mobileFlows": [
+        "56ccdccfe4b0875932734bde",
+        "56e0ae7fe4b052c006b6374e",
+        "56e99881e4b024f1336a19d8",
+        "583c54cee4b0e8e03b886a2b"
+      ]
+    },
+    {
+      "id": "502520fd0cf236b8a154bf8b",
+      "account": "4e6fa61772475eefd68fb5ef",
+      "group": "50251a010cfr36b8a1545e98",
+      "shortCode": "4e8b1b5afda5efeeec370e8a",
+      "name": "Test Vote",
+      "startDate": "Fri Aug 10 07:55:57 PDT 2012",
+      "endDate": null,
+      "status": "ACTIVE",
+      "mobileFlows": [
+        "502525030cf236b8a154bfc2",
+        "509430b101f280bc6a98bff8",
+        "58c1accde4b0369e60c920fb"
+      ]
+    }
+  ]
+}