sms77 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3620fb062cfa005c5da38bc6322048a6525d7aeb25b9f1be3f2c5995fbfc5f3a
-  data.tar.gz: 7411562537013fd906485c59278e03541c558f96f7207e1e931335952be1530b
+  metadata.gz: 621b698c5ea5c6f08f25ebb60d427a949fe8a011de54e82623234d4af10e0c7f
+  data.tar.gz: 11e68e54c358e93aacb25e6da5289d2fe904b8def5ef86ce9cdd2b1aac68ae35
 SHA512:
-  metadata.gz: 340cfd8ccb98a99d7458efd11d2172e31330147c515e63af019af9c0a5f731c92dd983673accbd1083df1547720bba9a4c258a91df074bd89f390a42141dc95b
-  data.tar.gz: 205dad2eb5dd22f48982077dfd6f3dc9849cf31bdd721fc747f07199c2468f2c04543bf7f60184d46bae70c63d1fa9726998114d75e22c511f5624e9d067b7c6
+  metadata.gz: b86d9e8884dad820fc01892f002c5e90de2162a40dd326c8c95c2cda8a404304924aeb02fc460f79f25aa78089d703662530a5e2995060ff2c8d3c9d4bfb6891
+  data.tar.gz: b3650f5844d714e1d925aaf31c8fd8e2b73b49c955220096654044239ef0fa978e3b00a3ae6ced2f8b9818825e8da3aa80ab908f79945204112add325abf78b2

data/README.md

@@ -11,7 +11,7 @@
 ```ruby
 require 'sms77'
 
-client = Sms77::Client.new(ENV['SMS77_API_KEY'], Faraday.new(Sms77::Client::BASE_URI))
+client = Sms77::Client.new(ENV['SMS77_API_KEY'])
 
-puts "Balance: #{client.balance.body}"
+puts "Balance: #{client.balance}"
 ```

data/lib/sms77/base.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'json'
+require 'faraday'
+require 'sms77/endpoint'
+
+module Sms77
+  class Base
+    BASE_PATH = '/api/'
+    CONN = Faraday.new("https://gateway.sms77.io#{BASE_PATH}")
+    HTTP_GET = CONN.method(:get).freeze
+    HTTP_POST = CONN.method(:post).freeze
+    CONN.freeze
+    HTTP_METHODS = [HTTP_GET, HTTP_POST].freeze
+    BUILDER = CONN.builder
+
+    def initialize(api_key, sent_with = 'ruby')
+      raise 'missing api_key in config' if api_key.to_s.empty?
+      raise 'missing sent_with in config' if sent_with.to_s.empty?
+
+      @api_key = api_key
+      @sent_with = sent_with
+
+      HTTP_METHODS.each do |method|
+        define_singleton_method(method.name) { |*args| request(method, *args) }
+      end
+    end
+
+    attr_reader :api_key, :sent_with
+
+    protected
+
+    def request(method, path, payload = {})
+      if !payload.empty? && HTTP_GET == method
+        path = "#{path}?#{URI.encode_www_form(payload)}"
+
+        payload = {}
+      end
+
+      method = method.name
+      headers = Hash[
+        Faraday::Request::Authorization::KEY, "Bearer #{@api_key}",
+        'sentWith', @sent_with
+      ]
+
+      res = CONN.run_request(method, path, payload, headers)
+
+      puts JSON.pretty_generate(res.to_hash.merge({
+                                                    :method => method,
+                                                    :path => path,
+                                                    :payload => payload,
+                                                    :req_headers => headers
+                                                  }).compact) if ENV['SMS77_DEBUG']
+
+      raise "Error requesting (#{self.class.name}) with code #{res.status}" unless 200 == res.status
+
+      raise 'Unexpected response' unless res.is_a?(Faraday::Response)
+
+      body = res.body
+
+      if body.is_a?(String)
+        begin
+          body = JSON.parse(body, :symbolize_names => true)
+        rescue StandardError
+          # Ignored
+        end
+      end
+
+      body.map! { |hash| hash.transform_keys(&:to_sym) } if body.is_a?(Array)
+
+      body
+    end
+  end
+end

data/lib/sms77/client.rb

@@ -4,27 +4,11 @@ require 'cgi'
 require 'json'
 require 'faraday'
 require 'sms77/endpoint'
-require 'sms77/contacts_action'
-require 'sms77/header'
+require 'sms77/contacts'
+require 'sms77/base'
 
 module Sms77
-  class Client
-    def initialize(api_key, conn, sent_with = 'ruby')
-      @api_key = api_key
-      @conn = conn
-      @sent_with = sent_with
-
-      raise 'missing api_key in config' if !@api_key || @api_key.empty?
-      raise 'missing conn in config' unless @conn
-
-      @conn.headers['sentWith'] = @sent_with
-      @conn.authorization :Bearer, @api_key
-    end
-
-    BASE_URI = 'https://gateway.sms77.io'
-    API_SUFFIX = '/api/'
-    API_URI = "#{BASE_URI}#{API_SUFFIX}"
-
+  class Client < Sms77::Base
     def analytics(params = {})
       get(Sms77::Endpoint::ANALYTICS, params)
     end
@@ -34,11 +18,17 @@ module Sms77
     end
 
     def contacts(params)
-      method(params['action'] == ContactsAction::READ ? 'get' : 'post').call(Sms77::Endpoint::CONTACTS, params)
+      get_or_post(Sms77::Contacts::Action::READ == params[:action], Sms77::Endpoint::CONTACTS, params)
+    end
+
+    def hooks(params)
+      Sms77::Hooks::Validator::validate(params)
+
+      get_or_post(Sms77::Hooks::Action::READ == params[:action], Sms77::Endpoint::HOOKS, params)
     end
 
     def lookup(params)
-      get(Sms77::Endpoint::LOOKUP, params)
+      post(Sms77::Endpoint::LOOKUP, params)
     end
 
     def pricing(params = {})
@@ -54,7 +44,7 @@ module Sms77
     end
 
     def validate_for_voice(params)
-      get(Sms77::Endpoint::VALIDATE_FOR_VOICE, params)
+      post(Sms77::Endpoint::VALIDATE_FOR_VOICE, params)
     end
 
     def voice(params)
@@ -63,36 +53,8 @@ module Sms77
 
     private
 
-    def get(endpoint, params = {})
-      request(endpoint, 'get', params)
-    end
-
-    def post(endpoint, params)
-      request(endpoint, 'post', params)
-    end
-
-    def request(endpoint, method, params)
-      url = "#{API_SUFFIX}#{endpoint}"
-
-      if ENV['SMS77_DEBUG']
-        puts "requesting url: #{url}"
-        puts "headers: #{@conn.headers.inspect}"
-      end
-
-      response = if method == 'get'
-                   @conn.get(url, params)
-                 else
-                   @conn.post do |req|
-                     req.path = url
-                     req.params = params
-                   end
-                 end
-
-      raise "Error requesting (#{self.class.name}) with code: #{response.status}" if response.status != 200
-
-      puts "received body: #{response.body}" if ENV['SMS77_DEBUG']
-
-      response
+    def get_or_post(bool, *args)
+      method(bool ? :get : :post).call(*args)
     end
   end
 end

data/lib/sms77/{contacts_action.rb → contacts.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Sms77
-  module ContactsAction
+module Sms77::Contacts
+  module Action
     DEL = 'del'
     READ = 'read'
     WRITE = 'write'

data/lib/sms77/endpoint.rb

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
 
-module Sms77
-  module Endpoint
-    ANALYTICS = 'analytics'
-    BALANCE = 'balance'
-    CONTACTS = 'contacts'
-    LOOKUP = 'lookup'
-    PRICING = 'pricing'
-    SMS = 'sms'
-    STATUS = 'status'
-    VALIDATE_FOR_VOICE = 'validate_for_voice'
-    VOICE = 'voice'
-  end
+module Sms77::Endpoint
+  ANALYTICS = 'analytics'
+  BALANCE = 'balance'
+  CONTACTS = 'contacts'
+  HOOKS = 'hooks'
+  LOOKUP = 'lookup'
+  PRICING = 'pricing'
+  SMS = 'sms'
+  STATUS = 'status'
+  VALIDATE_FOR_VOICE = 'validate_for_voice'
+  VOICE = 'voice'
 end

data/lib/sms77/hooks.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Sms77::Hooks
+  module Action
+    READ = 'read'
+    SUBSCRIBE = 'subscribe'
+    UNSUBSCRIBE = 'unsubscribe'
+  end
+
+  module EventType
+    NEW_INBOUND_SMS = 'sms_mo'
+    SMS_STATUS_UPDATE = 'dlr'
+    VOICE_STATUS_UPDATE = 'voice_status'
+  end
+
+  module RequestMethod
+    GET = 'GET'
+    POST = 'POST'
+  end
+
+  module Validator
+    def self.validate(params)
+      action = params[:action]
+
+      raise "Unknown action #{action}" unless Sms77::Hooks::Validator::is_action?(action)
+
+      if Sms77::Hooks::Action::SUBSCRIBE == action
+        raise 'Parameter validation failed' unless Sms77::Hooks::Validator::subscribe(params)
+      elsif Sms77::Hooks::Action::UNSUBSCRIBE == action
+        raise 'ID must be a positive integer' unless Sms77::Util::is_positive_integer?(params[:id])
+      end
+    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_action?(str)
+      Sms77::Util::in_module_constants?(str, Sms77::Hooks::Action)
+    end
+
+    def self.event_type?(str)
+      Sms77::Util::in_module_constants?(str, Sms77::Hooks::EventType)
+    end
+
+    def self.request_method?(str)
+      Sms77::Util::in_module_constants?(str, Sms77::Hooks::RequestMethod)
+    end
+
+    def self.target_url?(str)
+      Sms77::Util::is_valid_url?(str)
+    end
+  end
+end

data/lib/sms77/{lookup_type.rb → lookup.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Sms77
-  module LookupType
+module Sms77::Lookup
+  module Type
     CNAM = 'cnam'
     FORMAT = 'format'
     HLR = 'hlr'

data/lib/sms77/util.rb

@@ -0,0 +1,28 @@
+require 'date'
+
+module Sms77::Util
+  def self.get_module_constant_values(mod)
+    mod.constants(false).map &mod.method(:const_get)
+  end
+
+  def self.is_valid_url?(str)
+    str =~ URI::regexp
+  end
+
+  def self.is_valid_datetime?(str)
+    begin
+      DateTime.parse(str)
+      true
+    rescue ArgumentError
+      false
+    end
+  end
+
+  def self.is_positive_integer?(val)
+    /\A\d+\z/.match?(val.to_s)
+  end
+
+  def self.in_module_constants?(needle, mod)
+    get_module_constant_values(mod).include?(needle)
+  end
+end

data/lib/sms77/version.rb

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

data/sms77.gemspec

@@ -4,22 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sms77/version'
 
 Gem::Specification.new do |spec|
-  spec.name = 'sms77'
-  spec.version = Sms77::VERSION.dup
-  spec.summary = 'Official API Client for the Sms77.io SMS Gateway'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_runtime_dependency 'faraday', '~> 1.1'
+  spec.author = 'sms77 e.K.'
   spec.description = 'Send SMS & Text2Voice messages via the Sms77.io SMS Gateway.'
-  spec.authors = ['sms77 e.K.']
-  spec.email = ['support@sms77.io']
+  spec.email = 'support@sms77.io'
+  spec.files = `git ls-files`.split("\n")
   spec.homepage = 'https://github.com/sms77io/ruby-client'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.5'
-  spec.require_paths = ['lib']
-  spec.files = `git ls-files`.split("\n")
-  spec.test_files = Dir['test/**/*']
-
-  spec.add_runtime_dependency 'faraday', '~> 1'
-
-  spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'rake', '~> 13'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.name = 'sms77'
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.summary = 'Official API Client for the Sms77.io SMS Gateway'
+  spec.test_files = Dir['spec/**/*']
+  spec.version = Sms77::VERSION
 end

data/spec/sms77/balance_spec.rb

@@ -5,11 +5,6 @@ require 'sms77/endpoint'
 
 RSpec.describe Sms77, 'balance' do
   it 'returns the account balance' do
-    Helper.stubs.get("/api/#{Sms77::Endpoint::BALANCE}") { |_env| [200, {}, '12.34'] } unless Helper.is_http
-
-    response = Helper.client.balance
-
-    expect(response.class).to eq(Faraday::Response)
-    expect(response.body.to_f).to be_kind_of(Float)
+    expect(Helper.get(Sms77::Endpoint::BALANCE, 12.34)).to be_a(Float)
   end
 end

data/spec/sms77/client_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'sms77/endpoint'
+
+RSpec.describe Sms77, 'client' do
+  it 'checks api key' do
+    expect(Helper.client.api_key).to be_lengthy(String)
+  end
+
+  it 'checks sentWith' do
+    expect(Helper.client.sent_with).to be_lengthy(String)
+  end
+
+  it 'fails authentication' do
+    expect { Sms77::Client.new('') }.to raise_error(RuntimeError)
+  end
+end

data/spec/sms77/contacts_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 require 'sms77/endpoint'
-require 'sms77/contacts_action'
+require 'sms77/contacts'
 
 RSpec.describe Sms77, 'contacts' do
   $new_contact_id = nil
@@ -12,8 +12,8 @@ RSpec.describe Sms77, 'contacts' do
       code, $new_contact_id = response_body.split("\n")
       $new_contact_id = $new_contact_id.to_i
     else
-      code = response_body['return']
-      $new_contact_id = response_body['id']
+      code = response_body[:return]
+      $new_contact_id = response_body[:id]
     end
 
     expect(code).to be_numeric
@@ -28,9 +28,9 @@ RSpec.describe Sms77, 'contacts' do
       name = name.gsub('"', '')
       number = number.gsub('"', '')
     else
-      id = contact['ID']
-      name = contact['Name']
-      number = contact['Number']
+      id = contact[:ID]
+      name = contact[:Name]
+      number = contact[:Number]
     end
 
     expect(id).to be_numeric
@@ -39,7 +39,8 @@ RSpec.describe Sms77, 'contacts' do
   end
 
   def request(action, stub, extra_params = {})
-    Helper.request(Sms77::Endpoint::CONTACTS, { action: action }.merge(extra_params), stub)
+    Helper.method(Sms77::Contacts::Action::READ == action ? :get : :post)
+          .call(Sms77::Endpoint::CONTACTS, stub, { action: action }.merge(extra_params))
   end
 
   it 'returns all contacts as CSV' do
@@ -54,16 +55,16 @@ RSpec.describe Sms77, 'contacts' do
       "2925186";"Tom Tester";"004901234567890"
     CSV
 
-    body = request(Sms77::ContactsAction::READ, stub)
+    body = request(Sms77::Contacts::Action::READ, stub)
 
-    expect(body).to be_kind_of(String)
+    expect(body).to be_a(String)
 
     body.split("\n").each do |contact|
       assert_contact(contact)
     end
   end
 
-  it 'returns all contacts as CSV' do
+  it 'returns all contacts as JSON' do
     stub = [
       { ID: '4848436', Name: '', Number: '' },
       { ID: '4848437', Name: '', Number: '' },
@@ -75,9 +76,9 @@ RSpec.describe Sms77, 'contacts' do
       { ID: '2925186', Name: 'Tom Tester', Number: '004901234567890' }
     ]
 
-    body = request(Sms77::ContactsAction::READ, stub, { json: 1 })
+    body = request(Sms77::Contacts::Action::READ, stub, { json: 1 })
 
-    expect(body).to be_kind_of(Array)
+    expect(body).to be_a(Array)
 
     body.each do |contact|
       assert_contact(contact)
@@ -90,29 +91,29 @@ RSpec.describe Sms77, 'contacts' do
       4868400
     TEXT
 
-    body = request(Sms77::ContactsAction::WRITE, stub)
+    body = request(Sms77::Contacts::Action::WRITE, stub)
 
-    expect(body).to be_kind_of(String)
+    expect(body).to be_a(String)
 
     assert_new(body)
   end
 
   it 'deletes a contact with given ID and return code' do
-    expect(request(Sms77::ContactsAction::DEL, 152, { id: $new_contact_id })).to be_kind_of(Integer)
+    expect(request(Sms77::Contacts::Action::DEL, 152, { id: $new_contact_id })).to be_a(Integer)
   end
 
   it 'creates a contact and returns its ID as JSON' do
-    body = request(Sms77::ContactsAction::WRITE, { id: 4868401, return: '152' }, { json: 1 })
+    body = request(Sms77::Contacts::Action::WRITE, { id: 4868401, return: '152' }, { json: 1 })
 
-    expect(body).to be_kind_of(Hash)
+    expect(body).to be_a(Hash)
 
     assert_new(body)
   end
 
   it 'deletes a contact with given ID and return code as JSON' do
-    body = request(Sms77::ContactsAction::DEL, { return: '152' }, { id: $new_contact_id, json: 1 })
+    body = request(Sms77::Contacts::Action::DEL, { return: '152' }, { id: $new_contact_id, json: 1 })
 
-    expect(body).to be_kind_of(Hash)
-    expect(body['return']).to be_kind_of(String)
+    expect(body).to be_a(Hash)
+    expect(body[:return]).to be_a(String)
   end
 end