sms77 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 621b698c5ea5c6f08f25ebb60d427a949fe8a011de54e82623234d4af10e0c7f
-  data.tar.gz: 11e68e54c358e93aacb25e6da5289d2fe904b8def5ef86ce9cdd2b1aac68ae35
+  metadata.gz: 36eb3f4cd708334c2bda49e4c94c7eef521de326a94231cdfe0c53e76bdee13f
+  data.tar.gz: 4ab1e7ec064ee7b3fc3bb8415fe1f8b1b23721bdb786647e88bee187bcc620ac
 SHA512:
-  metadata.gz: b86d9e8884dad820fc01892f002c5e90de2162a40dd326c8c95c2cda8a404304924aeb02fc460f79f25aa78089d703662530a5e2995060ff2c8d3c9d4bfb6891
-  data.tar.gz: b3650f5844d714e1d925aaf31c8fd8e2b73b49c955220096654044239ef0fa978e3b00a3ae6ced2f8b9818825e8da3aa80ab908f79945204112add325abf78b2
+  metadata.gz: 0a1cfa14204af7aa47452dedbd5971f1f6d5e839651ef77fcabf94c6ebfc7995d4d78b2a5e77fa73d491bf3adf246fc32afe499919e5d9eddecc4817de6309f4
+  data.tar.gz: c7c7631464d9bdc25b84e227d00c6271d46d2ee16e710759e445e457f84e3e212de819401abfbb74d4e5f6cd1cdef338a407e857887a212d9e06923826bc6d1b

data/README.md

@@ -3,15 +3,27 @@
 # Ruby Client for the Sms77.io SMS Gateway API
 
 ## Installation
-
 ```gem install sms77```
 
 ### Usage
-
 ```ruby
 require 'sms77'
 
 client = Sms77::Client.new(ENV['SMS77_API_KEY'])
 
 puts "Balance: #{client.balance}"
-```
+```
+
+#### Testing
+```shell
+SMS77_API_KEY=MySms77ApiKey bundle exec rspec
+```
+
+*Optional environment variables*
+
+Setting ```SMS77_DEBUG=1``` prints details to stdout.
+
+Setting ```SMS77_TEST_HTTP=1``` enables live testing with actual API requests.
+
+##### Support
+Need help? Feel free to send us an <a href='mailto: support@sms77.io'>email</a>.

data/lib/sms77/client.rb

@@ -27,6 +27,10 @@ module Sms77
       get_or_post(Sms77::Hooks::Action::READ == params[:action], Sms77::Endpoint::HOOKS, params)
     end
 
+    def journal(params)
+      get(Sms77::Endpoint::JOURNAL, params)
+    end
+
     def lookup(params)
       post(Sms77::Endpoint::LOOKUP, params)
     end

data/lib/sms77/endpoint.rb

@@ -5,6 +5,7 @@ module Sms77::Endpoint
   BALANCE = 'balance'
   CONTACTS = 'contacts'
   HOOKS = 'hooks'
+  JOURNAL = 'journal'
   LOOKUP = 'lookup'
   PRICING = 'pricing'
   SMS = 'sms'

data/lib/sms77/journal.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sms77::Journal
+  module Type
+    INBOUND = 'inbound'
+    OUTBOUND = 'outbound'
+    REPLIES = 'replies'
+    VOICE = 'voice'
+  end
+
+  module Validator
+    def self.validate(params)
+      type = params[:type]
+      date_from = params[:date_from]
+      date_to = params[:date_to]
+
+      raise "Unknown type #{type}" unless Sms77::Journal::Validator::is_type?(type)
+      raise "Wrong date_from #{date_from}" unless Sms77::Journal::Validator::is_date?(date_from)
+      raise "Wrong date_to #{date_to}" unless Sms77::Journal::Validator::is_date?(date_to)
+    end
+
+    def self.subscribe(params)
+      { :request_method => Sms77::Hooks::RequestMethod::POST }.merge!(params)
+
+      self.event_type?(params[:event_type]) &&
+        self.request_method?(params[:request_method]) &&
+        self.target_url?(params[:target_url])
+    end
+
+    def self.is_type?(str)
+      Sms77::Util::in_module_constants?(str, Sms77::Journal::Type)
+    end
+
+    def self.is_date?(date)
+      date.is_a?(NilClass) || date.match(/[\d]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][\d]|3[0-1])/)
+    end
+  end
+end

data/lib/sms77/sms.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Sms77::Sms
+  module Type
+    DIRECT = 'direct'
+    ECONOMY = 'economy'
+  end
+end

data/lib/sms77/util.rb

@@ -25,4 +25,26 @@ module Sms77::Util
   def self.in_module_constants?(needle, mod)
     get_module_constant_values(mod).include?(needle)
   end
+
+  def self.valid_float?(str)
+    !!Float(str) rescue false
+  end
+
+  def self.numeric?(val)
+    return true if val.is_a?(Integer)
+
+    val.scan(/\D/).empty?
+  end
+
+  def self.boolean?(val)
+    [true, false].include? val
+  end
+
+  def self.nil_or_lengthy_string?(val)
+    val.nil? || (val.is_a?(String) && val.length)
+  end
+
+  def self.lengthy_string?(val)
+    return val.is_a?(String) && !val.empty?
+  end
 end

data/lib/sms77/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sms77
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/sms77/client_spec.rb

@@ -5,11 +5,11 @@ require 'sms77/endpoint'
 
 RSpec.describe Sms77, 'client' do
   it 'checks api key' do
-    expect(Helper.client.api_key).to be_lengthy(String)
+    expect(Helper.client.api_key).to be_lengthy_string
   end
 
   it 'checks sentWith' do
-    expect(Helper.client.sent_with).to be_lengthy(String)
+    expect(Helper.client.sent_with).to be_lengthy_string
   end
 
   it 'fails authentication' do

data/spec/sms77/journal_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'sms77/endpoint'
+require 'sms77/journal'
+require 'sms77/sms'
+
+RSpec.describe Sms77, 'journal' do
+  def valid_timestamp?(str)
+    str.match(/[\d]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][\d]|3[0-1]) (2[0-3]|[01][\d]):[0-5][\d]/)
+  end
+
+  def request(type)
+    stub = [{
+              :from => "SMS",
+              :id => "123456789",
+              :price => "1.2",
+              :text => "Hey my friend!",
+              :timestamp => "2020-10-14 14:25:04",
+              :to => "49170123456789",
+            }]
+
+    res = Helper.get(Sms77::Endpoint::JOURNAL, stub, { type: type })
+
+    expect(res).to be_a(Array)
+
+    res.each do |journal|
+      expect(journal).to be_a(Hash)
+      expect(journal[:from]).to be_lengthy_string
+      expect(journal[:id]).to be_numeric
+      expect(Sms77::Util::valid_float?(journal[:price])).to be_truthy
+      expect(journal[:text]).to be_lengthy_string
+      expect(valid_timestamp?(journal[:timestamp])).to be_truthy
+      expect(journal[:to]).to be_lengthy_string
+    end
+
+    res
+  end
+
+  it 'returns all inbound messages' do
+    request(Sms77::Journal::Type::INBOUND)
+  end
+
+  it 'returns all outbound messages' do
+    request(Sms77::Journal::Type::OUTBOUND).each do |journal|
+      journal.merge!({
+                       :connection => "http",
+                       :dlr => "DELIVERED",
+                       :dlr_timestamp => "2020-10-04 09:26:10.000",
+                       :foreign_id => "MyForeignId",
+                       :label => "MyCustomLabel",
+                       :latency => "5.1060",
+                       :mccmnc => "26207",
+                       :type => "direct",
+                     })
+      expect(journal[:connection]).to be_lengthy_string
+      expect(journal[:dlr]).to be_nil_or_lengthy_string
+      expect(valid_timestamp?(journal[:dlr_timestamp])).to be_truthy
+      expect(journal[:foreign_id]).to be_nil_or_lengthy_string
+      expect(journal[:label]).to be_nil_or_lengthy_string
+      expect(journal[:latency]).to be_nil_or_lengthy_string
+      expect(journal[:mccmnc]).to be_nil_or_lengthy_string
+      expect(Sms77::Util::in_module_constants?(journal[:type], Sms77::Sms::Type)).to be_truthy
+    end
+  end
+
+  it 'returns all voice messages' do
+    request(Sms77::Journal::Type::VOICE).each do |journal|
+      journal.merge!({
+                       :duration => "2",
+                       :error => "",
+                       :status => "completed",
+                       :xml => false,
+                     })
+      expect(journal[:duration]).to be_numeric
+      expect(journal[:error]).to be_nil_or_lengthy_string
+      expect(journal[:status]).to be_lengthy_string
+      expect(journal[:xml]).to be_boolean
+    end
+  end
+
+  it 'returns all reply messages' do
+    request(Sms77::Journal::Type::REPLIES)
+  end
+end

data/spec/spec_helper.rb

@@ -5,23 +5,27 @@ $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'sms77'
 require 'sms77/util'
 
+RSpec::Matchers.define :be_nil_or_lengthy_string do
+  match do |val|
+    Sms77::Util::nil_or_lengthy_string?(val)
+  end
+end
+
 RSpec::Matchers.define :be_boolean do
-  match do |value|
-    [true, false].include? value
+  match do |val|
+    Sms77::Util::boolean?(val)
   end
 end
 
 RSpec::Matchers.define :be_numeric do
-  match do |value|
-    return true if value.is_a?(Integer)
-
-    value.scan(/\D/).empty?
+  match do |val|
+    Sms77::Util::numeric?(val)
   end
 end
 
-RSpec::Matchers.define :be_lengthy do
-  match do |value|
-    return true if value.is_a?(String) && !Helper.client.sent_with.empty?
+RSpec::Matchers.define :be_lengthy_string do
+  match do |val|
+    Sms77::Util::lengthy_string?(val)
   end
 end
 
@@ -43,7 +47,7 @@ end
 
 class Helper
   @client = Sms77::Client.new(ENV['SMS77_DUMMY_API_KEY'], 'ruby-test')
-  @is_http = ENV.key?('TEST_HTTP').freeze
+  @is_http = ENV['SMS77_TEST_HTTP'].freeze
   @stubs = Faraday::Adapter::Test::Stubs.new
   @virtual_inbound_nr_eplus = '+491771783130'
   Sms77::Client::BUILDER.adapter(:test, @stubs) unless @is_http

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms77
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - sms77 e.K.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,7 +83,9 @@ files:
 - lib/sms77/contacts.rb
 - lib/sms77/endpoint.rb
 - lib/sms77/hooks.rb
+- lib/sms77/journal.rb
 - lib/sms77/lookup.rb
+- lib/sms77/sms.rb
 - lib/sms77/util.rb
 - lib/sms77/version.rb
 - sms77.gemspec
@@ -91,6 +93,7 @@ files:
 - spec/sms77/client_spec.rb
 - spec/sms77/contacts_spec.rb
 - spec/sms77/hooks_spec.rb
+- spec/sms77/journal_spec.rb
 - spec/sms77/lookup_spec.rb
 - spec/sms77/pricing_spec.rb
 - spec/sms77/sms_spec.rb
@@ -133,3 +136,4 @@ test_files:
 - spec/sms77/hooks_spec.rb
 - spec/sms77/balance_spec.rb
 - spec/sms77/validate_for_voice_spec.rb
+- spec/sms77/journal_spec.rb