aftalk 0.1.0

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+describe AfTalk::Configuration do
+  let(:api_key) { "abc123" }
+  let(:sandbox) { true }
+  let(:user_name) { "Thrive Global" }
+
+  before(:each) do
+    allow(AfTalk::Connection).to receive(:clear)
+
+    described_class.configure do |config|
+      config.api_key = api_key
+      config.sandbox = sandbox
+      config.user_name = user_name
+    end
+  end
+
+  describe ".api_key" do
+    let(:api_key) { nil }
+
+    before(:each) { stub_env_vars("AFRICAS_TALKING_API_KEY" => "env_key") }
+
+    context "when no api key is configured" do
+      it "uses the value set in dotenv" do
+        expect(described_class.api_key).to eq("env_key")
+      end
+    end
+  end
+
+  describe ".configure" do
+    it "allows setting version and api_key values" do
+      expect(described_class.api_key).to eq("abc123")
+      expect(described_class.user_name).to eq("Thrive Global")
+      expect(described_class.sandbox).to be
+    end
+
+    it "clears the connection" do
+      expect(AfTalk::Connection).to have_received(:clear)
+    end
+  end
+
+  describe ".sandbox" do
+    let(:sandbox) { nil }
+
+    before(:each) { stub_env_vars("AFRICAS_TALKING_SANDBOX" => "env_sandbox") }
+
+    context "when no api key is configured" do
+      it "uses the value set in dotenv" do
+        expect(described_class.sandbox).to eq("env_sandbox")
+      end
+    end
+  end
+
+  describe ".user_name" do
+    let(:user_name) { nil }
+
+    before(:each) { stub_env_vars("AFRICAS_TALKING_USER_NAME" => "env_user_name") }
+
+    context "when no api key is configured" do
+      it "uses the value set in dotenv" do
+        expect(described_class.user_name).to eq("env_user_name")
+      end
+    end
+  end
+
+  describe ".version" do
+    context "returns the default version" do
+      it "returns the default version" do
+        expect(described_class.version).to eq("version1")
+      end
+    end
+  end
+end

data/spec/unit/connection_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe AfTalk::Connection do
+  describe ".build" do
+    let(:instance) { double }
+
+    before(:each) do
+      allow(described_class).to receive(:new).and_return(instance)
+      allow(instance).to receive(:build)
+    end
+
+    it "calls #build on an instance" do
+      described_class.build
+      expect(instance).to have_received(:build)
+    end
+
+    it "is memoized" do
+      first_connection = described_class.build
+      second_connection = described_class.build
+      expect(first_connection).to be(second_connection)
+    end
+  end
+
+  describe ".clear" do
+    it "clears the memoization of the connection" do
+      first_connection = described_class.build
+      described_class.clear
+      second_connection = described_class.build
+      expect(first_connection).not_to be(second_connection)
+    end
+  end
+
+  describe "#build" do
+    let(:connection) { described_class.new.build }
+    let(:base_url) { connection.url_prefix.to_s }
+
+    context "in all modes" do
+      it "has the expected properties" do
+        headers = connection.headers
+
+        expect(connection.scheme).to eq("https")
+        expect(headers["Accept"]).to eq("application/json")
+        expect(headers["Apikey"]).to eq(AfTalk::Configuration.api_key)
+      end
+    end
+
+    context "in sandbox mode" do
+      before(:each) do
+        stub_env_vars("SANDBOX" => "true")
+      end
+
+      it "uses the sandbox url" do
+        expect(base_url).to match(described_class::SANDBOX_URL)
+      end
+    end
+
+    context "in production mode" do
+      before(:each) do
+        stub_env_vars("AFRICAS_TALKING_SANDBOX" => nil)
+      end
+
+      it "uses the production url" do
+        expect(base_url).to match(described_class::URL)
+      end
+    end
+  end
+end

data/spec/unit/request_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe AfTalk::Request do
+  let(:connection) { double("connection") }
+  let(:get_response) { double("get_response") }
+  let(:post_response) { double("post_response") }
+  let(:api_key) { "abc123" }
+  let(:user_name) { "Thrive Global" }
+  let(:default_params) { { username: user_name } }
+  let(:options) { { foo: "bar" } }
+
+  before(:each) do
+    allow(AfTalk::Connection).to receive(:build).and_return(connection)
+  end
+
+  describe ".get" do
+    it "creates an instance and sends #get to it" do
+      instance = double
+      allow(described_class).to receive(:new).and_return(instance)
+      allow(instance).to receive(:get).
+        with("/path", options).
+        and_return(get_response)
+
+      expect(described_class.get("/path", options)).to eq(get_response)
+    end
+  end
+
+  describe ".post" do
+    it "creates an instance and sends #post to it" do
+      instance = double
+      allow(described_class).to receive(:new).and_return(instance)
+      allow(instance).to receive(:post).
+        with("/path", options).
+        and_return(get_response)
+
+      expect(described_class.post("/path", options)).to eq(get_response)
+    end
+  end
+
+  describe "#get" do
+    it "returns the response of doing a get to an API endpoint" do
+      allow(connection).to receive(:get).
+        with("/version1/test", options.merge(default_params)).
+        and_return(get_response)
+
+      expect(described_class.new.get("/test", options)).to eq(get_response)
+    end
+  end
+
+  describe "#post" do
+    it "returns the response of doing a post to an API endpoint" do
+      allow(connection).to receive(:post).
+        with("/version1/test", options.merge(default_params)).
+        and_return(post_response)
+
+      expect(described_class.new.post("/test", options)).to eq(post_response)
+    end
+  end
+end

data/spec/unit/response_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe AfTalk::Response do
+  describe ".new" do
+    subject { described_class.new(response) }
+
+    context "when the response code is a success code" do
+      let(:response) { double(status: 200, body: { foo: "bar" }) }
+
+      it "sets the status and the body" do
+        expect(subject.status).to eq(200)
+        expect(subject.body).to eq(foo: "bar")
+        expect(subject.error_message).to be_nil
+      end
+    end
+
+    context "when the response code is a failure code" do
+      let(:response) { double(status: 400, body: "Something went wrong.") }
+
+      it "sets the status, the body, and the error message" do
+        expect(subject.status).to eq(400)
+        expect(subject.body).to eq(error: "Something went wrong.")
+        expect(subject.error_message).to eq("Something went wrong.")
+      end
+    end
+  end
+end

data/spec/unit/responses/send_message_response_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe AfTalk::SendMessageResponse do
+  describe ".new" do
+    subject { described_class.new(response) }
+
+    context "when the response is a success" do
+      let(:response) { double(body: data, status: 201) }
+      let(:data) do
+        {
+          SMSMessageData: {
+            Message: "The message was delivered.",
+            Recipients: [recipient_data],
+          },
+        }
+      end
+      let(:recipient_data) { double("RecipientData") }
+      let(:message_status) { double("MessageStatus") }
+
+      before(:each) do
+        allow(AfTalk::SmsMessageStatus).to receive(:new).
+          with(recipient_data).
+          and_return(message_status)
+      end
+
+      it "sets a message and initializes recipients" do
+        expect(subject).to be_kind_of(AfTalk::Response)
+        expect(subject.message).to eq(response.body[:SMSMessageData][:Message])
+        expect(subject.recipients).to eq([message_status])
+      end
+    end
+
+    context "when the response is not a success" do
+      let(:response) { double(body: "This failed.", status: 400) }
+
+      it "doesn't set a message or recipients" do
+        expect(subject).to be_kind_of(AfTalk::Response)
+        expect(subject.message).to be_nil
+        expect(subject.recipients).to be_nil
+      end
+    end
+  end
+end

data/spec/unit/sms_message_status_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe AfTalk::SmsMessageStatus do
+  let(:options) {
+    {
+      cost: "USD 0.0200",
+      messageId: "ATXid_39b49d3e64107e6b859cab4we2900a07",
+      number: "+15555554563",
+      status: "Success",
+    }
+  }
+
+  subject { described_class.new(options) }
+
+  describe ".new" do
+    it "sets the expected attributes" do
+      expect(subject.cost).to eq(options[:cost])
+      expect(subject.message_id).to eq(options[:messageId])
+      expect(subject.number).to eq(options[:number])
+      expect(subject.status).to eq(options[:status])
+    end
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: aftalk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thrive Global Engineering Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "    A Ruby wrapper for Africa's Talking telephony services (https://africastalking.com)\n"
+email:
+- techadmin@thriveglobal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- africas_talking_api.gemspec
+- lib/aftalk.rb
+- lib/aftalk/client.rb
+- lib/aftalk/configuration.rb
+- lib/aftalk/connection.rb
+- lib/aftalk/exceptions.rb
+- lib/aftalk/request.rb
+- lib/aftalk/response.rb
+- lib/aftalk/responses/send_message_response.rb
+- lib/aftalk/sms_message_status.rb
+- lib/aftalk/version.rb
+- spec/aftalk_spec.rb
+- spec/integration/send_message_spec.rb
+- spec/spec_helper.rb
+- spec/support/env_vars.rb
+- spec/unit/client_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/connection_spec.rb
+- spec/unit/request_spec.rb
+- spec/unit/response_spec.rb
+- spec/unit/responses/send_message_response_spec.rb
+- spec/unit/sms_message_status_spec.rb
+homepage: https://github.com/thriveglobal/africas_talking_api
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: API wrapper for Africa's Talking services
+test_files:
+- spec/aftalk_spec.rb
+- spec/integration/send_message_spec.rb
+- spec/spec_helper.rb
+- spec/support/env_vars.rb
+- spec/unit/client_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/connection_spec.rb
+- spec/unit/request_spec.rb
+- spec/unit/response_spec.rb
+- spec/unit/responses/send_message_response_spec.rb
+- spec/unit/sms_message_status_spec.rb