aftalk 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e93ac6c06f96ef4f6e3127eefdeec2f8e3d55467
-  data.tar.gz: 3cb611a13074f088a939ff4138de64b8390f2e1d
+  metadata.gz: d2ec14f0bf217c0d998f9ac7fe0174b55e791b5d
+  data.tar.gz: 214b21204ef61173687c8bf7800d686debdcf10b
 SHA512:
-  metadata.gz: b47b57d4fc8467dffab8be0d385a4bf52972f4ced94f6d79406349171792d32e8bd1b7febde92c9b0bfeb2416f99385114986da8d31478ec0f2691e8fa240eb2
-  data.tar.gz: 50d50f2677eff0b0d78eca81ecb71dc7042e067dd2dd0fd7c8aa4cd72b0ccff6a1c706d1e5550146ae60cf1bc2a23d2254a18cc5a4379d88bfa1a3e73ba79f96
+  metadata.gz: d73a014f67d8333641c44ae8a015bb71adab5cc0e15d758f4819401d13ef5769b6f082832c83fcdc79abb7877337d794254c26de31fb2795836e7511cff038ab
+  data.tar.gz: 5660ba0779adf7af9c16e655c783cc7f7b4e3b965daf2de158e4f67b92e4b52bc2ee5b544d12f4fd79a59d09ea9fa1e71321c28d668c35fc752ab403b83a261c

data/.gitignore

@@ -14,6 +14,9 @@
 # Used by dotenv library to load environment variables.
 .env
 
+# Byebug
+.byebug_history
+
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/

data/README.md

@@ -1,11 +1,13 @@
+[![Gem](https://badge.fury.io/rb/aftalk.svg)](https://rubygems.org/gems/aftalk)
 [![Build](https://circleci.com/gh/thriveglobal/aftalk.svg?&style=shield&circle-token=ade67468e07185e650dc6ba100127bce34bd10b5)](https://circleci.com/gh/thriveglobal/aftalk)
 [![Maintainability](https://api.codeclimate.com/v1/badges/8d84a0d4fc06f1c49cd8/maintainability)](https://codeclimate.com/github/thriveglobal/aftalk/maintainability)
 
+
 # aftalk
 
-A Ruby wrapper for [Africa's Talking](https://africastalking.com) telephony services.
+This is a Ruby wrapper for [Africa's Talking](https://africastalking.com) telephony services.
 
-Currently the only endpoint supported is the `/messaging` POST endpoint that allows you to send SMS messages. Support for other endpoints is planned for future releases.
+**NOTE:** Currently the gem supports only the `/messaging` endpoint, which is for for sending (POST) and fetching (GET) SMS messages. Support for other endpoints is planned for future releases.
 
 ## Installation
 
@@ -55,7 +57,7 @@ Make sure this code runs before you try to use the API.
 
 ## Usage
 
-To send an SMS:
+### Send an SMS message
 
 ```ruby
 phone_number = "+15555555555"
@@ -66,4 +68,14 @@ AfTalk.send_message(
   message: message,
 )
 ```
-The `send_message` method requires `to` and `message` parameters, but also supports all optional parameters supported by the API. For a full list, see [the API docs](http://docs.africastalking.com/sms/sending/). 
+The `send_message` method requires `to` and `message` keyword arguments, and also supports all optional parameters supported by the API. For a full list, see [the SMS sending API docs](http://docs.africastalking.com/sms/sending/). 
+
+### Fetch SMS messages
+
+```ruby
+AfTalk.fetch_messages(
+  last_received_id: 0,
+)
+```
+
+The `fetch_messages` method requires a `last_received_id` keyword argument and ignores any other parameters you pass to it. See [the SMS fetch messages API docs](http://docs.africastalking.com/sms/fetchmessages/) for more details. 

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+
+namespace :irb do
+  desc "Open interactive REPL with our application preloaded"
+
+  task :console do
+    system("irb -r ./lib/aftalk.rb")
+  end
+end

data/{africas_talking_api.gemspec → aftalk.gemspec}

@@ -17,11 +17,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 
   spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_dependency "dotenv", "~>2.2"
-  spec.add_dependency "faraday", "~> 0.13"
-  spec.add_dependency "faraday_middleware", "~> 0.12"
+  spec.add_development_dependency "byebug", "~> 9.1"
   spec.add_development_dependency "rake", "~> 12"
   spec.add_development_dependency "rspec", "~> 3.7"
   spec.add_development_dependency "rspec_junit_formatter", "~> 0.3"
   spec.add_development_dependency "vcr", "~> 3.0"
+
+  spec.add_dependency "dotenv", "~>2.2"
+  spec.add_dependency "faraday", "~> 0.13"
+  spec.add_dependency "faraday_middleware", "~> 0.12"
 end

data/lib/aftalk/client.rb

@@ -1,14 +1,26 @@
 module AfTalk
   module Client
+    SMS_ENDPOINT = "/messaging".freeze
+
     def send_message(to:, message:, **options)
       messaging_params = { to: to, message: message }.merge(options)
-      response = post("/messaging", messaging_params)
+      AfTalk::SendMessageResponse.new(
+        post(SMS_ENDPOINT, messaging_params),
+      )
+    end
 
-      AfTalk::SendMessageResponse.new(response)
+    def fetch_messages(last_received_id:)
+      AfTalk::FetchMessagesResponse.new(
+        get(SMS_ENDPOINT, lastReceivedId: last_received_id),
+      )
     end
 
     private
 
+    def get(endpoint, **options)
+      request.get(endpoint, options)
+    end
+
     def post(endpoint, **options)
       request.post(endpoint, options)
     end

data/lib/aftalk/responses/fetch_messages_response.rb

@@ -0,0 +1,20 @@
+module AfTalk
+  class FetchMessagesResponse < Response
+    attr_reader :messages
+
+    def initialize(response)
+      super(response)
+      if success?
+        @messages = body_data[:Messages].map do |message_data|
+          AfTalk::SmsMessageInfo.new(message_data)
+        end
+      end
+    end
+
+    private
+
+    def body_data
+      body[:SMSMessageData]
+    end
+  end
+end

data/lib/aftalk/sms_message_info.rb

@@ -0,0 +1,13 @@
+module AfTalk
+  class SmsMessageInfo
+    attr_reader :date, :from, :link_id, :message_id, :to
+
+    def initialize(data = {})
+      @date = data[:date]
+      @from = data[:from]
+      @link_id = data[:linkId]
+      @message_id = data[:id]
+      @to = data[:to]
+    end
+  end
+end

data/lib/aftalk/sms_message_status.rb

@@ -2,11 +2,11 @@ module AfTalk
   class SmsMessageStatus
     attr_reader :cost, :message_id, :number, :status
 
-    def initialize(opts = {})
-      @cost = opts[:cost]
-      @message_id = opts[:messageId]
-      @number = opts[:number]
-      @status = opts[:status]
+    def initialize(data = {})
+      @cost = data[:cost]
+      @message_id = data[:messageId]
+      @number = data[:number]
+      @status = data[:status]
     end
   end
 end

data/lib/aftalk/version.rb

@@ -1,3 +1,3 @@
 module AfTalk
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

data/spec/integration/fetch_messages_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe AfTalk do
+  describe "#fetch_messages" do
+    before(:each) { reset_config }
+
+    let(:options) { { last_received_id: 0 } }
+
+    it "produces a fetch messages response object" do
+      VCR.use_cassette("aftalk/messaging/fetch_messages") do
+        response = described_class.fetch_messages(options)
+        expect(response.error_message).to be_nil
+        expect(response.status).to eq(200)
+        expect(response.messages).to eq([])
+      end
+    end
+  end
+end

data/spec/integration/send_message_spec.rb

@@ -2,6 +2,8 @@ require "spec_helper"
 
 describe AfTalk do
   describe "#send_message" do
+    before(:each) { reset_config }
+
     let(:options) do
       { to: "+14125554563", message: "Hello World!", foo: "bar" }
     end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require "rspec"
 require "aftalk"
 require "vcr"
+require "byebug"
 
 current_path = File.expand_path("../", __FILE__)
 Dir["#{current_path}/support/**/*.rb"].each { |file| require file }

data/spec/support/reset_config.rb

@@ -0,0 +1,11 @@
+module ResetConfig
+  def reset_config
+    config = AfTalk::Configuration
+    config.api_key = nil
+    config.user_name = nil
+  end
+end
+
+RSpec.configure do |config|
+  config.include ResetConfig
+end

data/spec/unit/client_spec.rb

@@ -9,12 +9,12 @@ describe AfTalk::Client do
   end
 
   before(:all) { reset_config }
+  let(:response) { double(headers: { "content-type" => "application/json" }) }
 
   describe "#send_message" do
     let(:options) {
       { to: "+14125554563", message: "Hello World!", foo: "bar" }
     }
-    let(:response) { double(headers: { "content-type" => "application/json" }) }
 
     context "with all required options" do
       it "it instantiates a send message response" do
@@ -38,9 +38,20 @@ describe AfTalk::Client do
     end
   end
 
-  def reset_config
-    config = AfTalk::Configuration
-    config.api_key = nil
-    config.user_name = nil
+  describe "#fetch_messages" do
+    let(:options) { { last_received_id: "abc123" } }
+
+    context "with all required options" do
+      it "it instantiates a fetch messages response" do
+        allow(AfTalk::Request).to receive(:get).
+          with("/messaging", lastReceivedId: options[:last_received_id]).
+          and_return(response)
+        allow(AfTalk::FetchMessagesResponse).to receive(:new).with(response)
+
+        subject.fetch_messages(options)
+
+        expect(AfTalk::FetchMessagesResponse).to have_received(:new).with(response)
+      end
+    end
   end
 end

data/spec/unit/configuration_spec.rb

@@ -28,7 +28,7 @@ describe AfTalk::Configuration do
   end
 
   describe ".configure" do
-    it "allows setting version and api_key values" do
+    it "allows setting version, sandbox, 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
@@ -44,7 +44,7 @@ describe AfTalk::Configuration do
 
     before(:each) { stub_env_vars("AFRICAS_TALKING_SANDBOX" => "env_sandbox") }
 
-    context "when no api key is configured" do
+    context "when no sandbox value is configured" do
       it "uses the value set in dotenv" do
         expect(described_class.sandbox).to eq("env_sandbox")
       end

data/spec/unit/responses/fetch_messages_response_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe AfTalk::FetchMessagesResponse do
+  describe ".new" do
+    subject { described_class.new(response) }
+
+    context "when the response is a success" do
+      let(:response) { double(body: data, status: 200) }
+      let(:data) do
+        {
+          SMSMessageData: {
+            Messages: [message_data],
+          },
+        }
+      end
+      let(:message_data) { double("MessageData") }
+      let(:message_info) { double("MessageInfo") }
+
+      before(:each) do
+        allow(AfTalk::SmsMessageInfo).to receive(:new).
+          with(message_data).
+          and_return(message_info)
+      end
+
+      it "sets messages" do
+        expect(subject).to be_kind_of(AfTalk::Response)
+        expect(subject.messages).to eq([message_info])
+      end
+    end
+  end
+end

data/spec/unit/sms_message_info_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe AfTalk::SmsMessageInfo do
+  let(:data) {
+    {
+      date: "2012-07-15 15:40:06",
+      from: "+15555554563",
+      id: "12345",
+      linkId: "foo",
+      to: "+15555554564",
+    }
+  }
+
+  subject { described_class.new(data) }
+
+  describe ".new" do
+    it "sets the expected attributes" do
+      expect(subject.date).to eq(data[:date])
+      expect(subject.from).to eq(data[:from])
+      expect(subject.link_id).to eq(data[:linkId])
+      expect(subject.message_id).to eq(data[:id])
+      expect(subject.to).to eq(data[:to])
+    end
+  end
+end

data/spec/unit/sms_message_status_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe AfTalk::SmsMessageStatus do
-  let(:options) {
+  let(:data) {
     {
       cost: "USD 0.0200",
       messageId: "ATXid_39b49d3e64107e6b859cab4we2900a07",
@@ -10,14 +10,14 @@ describe AfTalk::SmsMessageStatus do
     }
   }
 
-  subject { described_class.new(options) }
+  subject { described_class.new(data) }
 
   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])
+      expect(subject.cost).to eq(data[:cost])
+      expect(subject.message_id).to eq(data[:messageId])
+      expect(subject.number).to eq(data[:number])
+      expect(subject.status).to eq(data[:status])
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aftalk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Hoffman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,103 +25,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
+        version: '9.1'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '9.1'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :runtime
+        version: '12'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '12'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :runtime
+        version: '3.7'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
+        version: '2.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '0.13'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        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'
 description: "    A Ruby wrapper for Africa's Talking telephony services (https://africastalking.com)\n"
 email:
 - techadmin@thriveglobal.com
@@ -135,7 +149,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- africas_talking_api.gemspec
+- aftalk.gemspec
 - lib/aftalk.rb
 - lib/aftalk/client.rb
 - lib/aftalk/configuration.rb
@@ -143,19 +157,25 @@ files:
 - lib/aftalk/exceptions.rb
 - lib/aftalk/request.rb
 - lib/aftalk/response.rb
+- lib/aftalk/responses/fetch_messages_response.rb
 - lib/aftalk/responses/send_message_response.rb
+- lib/aftalk/sms_message_info.rb
 - lib/aftalk/sms_message_status.rb
 - lib/aftalk/version.rb
 - spec/aftalk_spec.rb
+- spec/integration/fetch_messages_spec.rb
 - spec/integration/send_message_spec.rb
 - spec/spec_helper.rb
 - spec/support/env_vars.rb
+- spec/support/reset_config.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/fetch_messages_response_spec.rb
 - spec/unit/responses/send_message_response_spec.rb
+- spec/unit/sms_message_info_spec.rb
 - spec/unit/sms_message_status_spec.rb
 homepage: https://github.com/thriveglobal/aftalk
 licenses:
@@ -183,13 +203,17 @@ specification_version: 4
 summary: API wrapper for Africa's Talking services
 test_files:
 - spec/aftalk_spec.rb
+- spec/integration/fetch_messages_spec.rb
 - spec/integration/send_message_spec.rb
 - spec/spec_helper.rb
 - spec/support/env_vars.rb
+- spec/support/reset_config.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/fetch_messages_response_spec.rb
 - spec/unit/responses/send_message_response_spec.rb
+- spec/unit/sms_message_info_spec.rb
 - spec/unit/sms_message_status_spec.rb