sms77 0.0.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe2489e8f42e261bf888d5d5d86805caba5e7a293dae1020399069b37ba26e2a
-  data.tar.gz: cbb1faa8e91e0c29df20fa27ed31c8baa8a8655582fa180b64d45b24b27545a1
+  metadata.gz: 5dcd3acfda05ed3752e5d11fdd3218268ff39a9637373548fc7652845738c24c
+  data.tar.gz: f4a42f418594d53610fd89b2494c83555c654cc4401a1ebabf97d1e20feee5a6
 SHA512:
-  metadata.gz: f0db040721b53efa7b02a8dc48af77d7ca6d43f0e5a8f0cdbae8700fef7abd856dd52fa149d68f3e61740a25761b37336274d0f65b3fa7d82071814be65cd824
-  data.tar.gz: b22a80577d8b440de469a221f6013bf3fff1daa7ca9f3a8f8df9e9e59f7cfe94aef6ab79bf76c07b0cff800315acd1ac9c91e0b3f1f62a6dd29f01478cb85756
+  metadata.gz: 310757899c3eb52bbd50122271aada73242b984cbc83fc63361ae183e13ac410c6c9701214ddfc6124e1cb179ca5f2b2b1d075d533066b36b3ef814c015e3393
+  data.tar.gz: f4788dbac05a014e4ba53be45036e7db02f80d78d99fa7b0078779ac34b9349b6185f7c65db929e413f798e374746fe9f4384ce124afe953a36452bad68619eb

data/.gitignore

@@ -1,4 +1,4 @@
-/.idea
-sms77.gem
+build/
+*.gem
 Gemfile.lock
 .ruby-gemset

data/README.md

@@ -1,6 +1,6 @@
-![](https://www.sms77.io/wp-content/uploads/2019/07/sms77-Logo-400x79.png "Sms77.io Logo")
+![Sms77.io Logo](https://www.sms77.io/wp-content/uploads/2019/07/sms77-Logo-400x79.png "Sms77.io Logo")
 
-# Sms77.io SMS Gateway API Client
+# Ruby Client for the Sms77.io SMS Gateway API
 
 ## Installation
 
@@ -9,7 +9,27 @@
 ### Usage
 
 ```ruby
-client = Sms77::Client.new(api_key: ENV['SMS77_API_KEY'])
-balance = client.get(url: '/api/balance')
-puts balance.inspect
-```
+require 'sms77'
+
+puts Sms77::Client.new(Sms77::Resource(ENV['SMS77_API_KEY'])).Balance.retrieve
+# or
+puts Sms77::Resources::Balance.new(ENV['SMS77_API_KEY']).retrieve
+```
+
+#### 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 [contact us](https://www.sms77.io/en/company/contact/).
+
+[![MIT](https://img.shields.io/badge/License-MIT-teal.svg)](./LICENSE)

data/lib/sms77.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'sms77/version'
-require 'sms77/client'
 
 module Sms77
 end

data/lib/sms77/client.rb

@@ -1,98 +1,29 @@
 # frozen_string_literal: true
 
-require 'cgi'
-require 'json'
-require 'faraday'
-require 'sms77/endpoint'
-require 'sms77/contacts_action'
-require 'sms77/header'
+require 'sms77/resources/analytics'
+require 'sms77/resources/balance'
+require 'sms77/resources/contacts'
+require 'sms77/resources/hooks'
+require 'sms77/resources/journal'
+require 'sms77/resources/lookup'
+require 'sms77/resources/pricing'
+require 'sms77/resources/sms'
+require 'sms77/resources/status'
+require 'sms77/resources/validate_for_voice'
+require 'sms77/resources/voice'
+require 'sms77/util'
 
 module Sms77
   class Client
-    def initialize(api_key, conn, sent_with = 'ruby')
-      @api_key = api_key
-      @conn = conn
-      @sent_with = sent_with
+    # @param resource [Sms77::Resource]
+    def initialize(resource)
+      Sms77::Util::get_namespace_classes(Sms77::Resources).each do |cls|
+        name = cls.name.split('::').last
 
-      raise 'missing api_key in config' if !@api_key || @api_key.empty?
-      raise 'missing conn in config' unless @conn
+        instance_variable_set("@#{name}", cls.new(resource))
 
-      @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}"
-
-    def analytics(params = {})
-      get(Sms77::Endpoint::ANALYTICS, params)
-    end
-
-    def balance
-      get(Sms77::Endpoint::BALANCE)
-    end
-
-    def contacts(params)
-      method(params['action'] == ContactsAction::READ ? 'get' : 'post').call(Sms77::Endpoint::CONTACTS, params)
-    end
-
-    def lookup(params)
-      get(Sms77::Endpoint::LOOKUP, params)
-    end
-
-    def pricing(params = {})
-      get(Sms77::Endpoint::PRICING, params)
-    end
-
-    def sms(params)
-      post(Sms77::Endpoint::SMS, params)
-    end
-
-    def status(params)
-      get(Sms77::Endpoint::STATUS, params)
-    end
-
-    def validate_for_voice(params)
-      get(Sms77::Endpoint::VALIDATE_FOR_VOICE, params)
-    end
-
-    def voice(params)
-      post(Sms77::Endpoint::VOICE, params)
-    end
-
-    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}"
+        singleton_class.instance_eval("attr_reader :#{name}")
       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
     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,15 @@
 # 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'
+  JOURNAL = 'journal'
+  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,64 @@
+# frozen_string_literal: true
+
+module Sms77::Hooks
+  module Action
+    READ = 'read'
+    SUBSCRIBE = 'subscribe'
+    UNSUBSCRIBE = 'unsubscribe'
+  end
+
+  module EventType
+    ALL = 'all'
+    NEW_INBOUND_SMS = 'sms_mo'
+    SMS_STATUS_UPDATE = 'dlr'
+    VOICE_STATUS_UPDATE = 'voice_status'
+  end
+
+  module RequestMethod
+    GET = 'GET'
+    JSON = 'JSON'
+    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::Hooks::Validator::unsubscribe(params)
+      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.unsubscribe(params)
+      Sms77::Util::is_positive_integer?(params[:id])
+    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/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/{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/resource.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'json'
+require 'faraday'
+require 'sms77/endpoint'
+
+module Sms77
+  class Resource
+    attr_reader :api_key, :endpoint, :sent_with, :http_methods, :request_methods, :builder, :conn
+
+    BASE_PATH = '/api/'
+
+    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
+      @endpoint = self.class.get_endpoint
+      @http_methods = self.class.get_http_methods
+      @conn = Faraday.new("https://gateway.sms77.io#{BASE_PATH}")
+    end
+
+    protected
+
+    def request(payload = {}, query = {})
+      path = @endpoint
+      http_method = @http_methods[caller_locations.first.label.to_sym]
+
+      if :get == http_method
+        query = payload
+
+        payload = {}
+      end
+
+      query.each do |key, val|
+        query.store(key, Sms77::Util::to_numbered_bool(val))
+      end
+
+      payload.each do |key, val|
+        payload.store(key, Sms77::Util::to_numbered_bool(val))
+      end
+
+      unless query.empty?
+        path = "#{path}?#{URI.encode_www_form(query)}"
+      end
+
+      headers = Hash[
+        Faraday::Request::Authorization::KEY, "Bearer #{@api_key}",
+        'sentWith', @sent_with
+      ]
+
+      res = @conn.run_request(http_method, path, payload, headers)
+
+      puts JSON.pretty_generate(res.to_hash.merge({
+                                                    :method => http_method,
+                                                    :path => path,
+                                                    :payload => payload,
+                                                    :req_headers => headers,
+                                                    :query => query,
+                                                  }).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
+
+    class << self
+      def get_http_methods
+        @http_methods
+      end
+
+      def get_endpoint
+        @endpoint
+      end
+    end
+  end
+end

data/lib/sms77/resources/analytics.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+module Sms77::Resources
+  class Analytics < Sms77::Resource
+    @endpoint = Sms77::Endpoint::ANALYTICS
+    @http_methods = {
+      :retrieve => :get,
+    }
+
+    def retrieve(params = {})
+      request(params)
+    end
+  end
+end