v0.3: switched to resource based approch

Author: matthiez

README.md

@@ -3,18 +3,21 @@
 # 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}"
+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
 ```
@@ -26,4 +29,5 @@ 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>.

lib/sms77.rb

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

lib/sms77/client.rb

@@ -1,64 +1,29 @@
 # frozen_string_literal: true
 
-require 'cgi'
-require 'json'
-require 'faraday'
-require 'sms77/endpoint'
-require 'sms77/contacts'
-require 'sms77/base'
+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 < Sms77::Base
-    def analytics(params = {})
-      get(Sms77::Endpoint::ANALYTICS, params)
-    end
-
-    def balance
-      get(Sms77::Endpoint::BALANCE)
-    end
-
-    def 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 journal(params)
-      get(Sms77::Endpoint::JOURNAL, params)
-    end
-
-    def lookup(params)
-      post(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)
-      post(Sms77::Endpoint::VALIDATE_FOR_VOICE, params)
-    end
-
-    def voice(params)
-      post(Sms77::Endpoint::VOICE, params)
-    end
+  class Client
+    # @param resource [Sms77::Resource]
+    def initialize(resource)
+      Sms77::Util::get_namespace_classes(Sms77::Resources).each do |cls|
+        name = cls.name.split('::').last
 
-    private
+        instance_variable_set("@#{name}", cls.new(resource))
 
-    def get_or_post(bool, *args)
-      method(bool ? :get : :post).call(*args)
+        singleton_class.instance_eval("attr_reader :#{name}")
+      end
     end
   end
 end

lib/sms77/hooks.rb

@@ -27,7 +27,7 @@ def self.validate(params)
       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])
+        raise 'ID must be a positive integer' unless Sms77::Hooks::Validator::unsubscribe(params)
       end
     end
 
@@ -39,6 +39,10 @@ def self.subscribe(params)
         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

lib/sms77/base.rb renamed to lib/sms77/resource.rb

@@ -6,51 +6,59 @@
 require 'sms77/endpoint'
 
 module Sms77
-  class Base
+  class Resource
+    attr_reader :api_key, :endpoint, :sent_with, :http_methods, :request_methods, :builder, :conn
+
     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
+      @endpoint = self.class.get_endpoint
+      @http_methods = self.class.get_http_methods
+      @conn = Faraday.new("https://gateway.sms77.io#{BASE_PATH}")
     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)}"
+    def request(payload = {}, query = {})
+      path = @endpoint
+      http_method = @http_methods[caller_locations.first.label.to_sym]
+
+      if :get == http_method
+        query = payload
 
         payload = {}
       end
 
-      method = method.name
+      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(method, path, payload, headers)
+      res = @conn.run_request(http_method, path, payload, headers)
 
       puts JSON.pretty_generate(res.to_hash.merge({
-                                                    :method => method,
+                                                    :method => http_method,
                                                     :path => path,
                                                     :payload => payload,
-                                                    :req_headers => headers
+                                                    :req_headers => headers,
+                                                    :query => query,
                                                   }).compact) if ENV['SMS77_DEBUG']
 
       raise "Error requesting (#{self.class.name}) with code #{res.status}" unless 200 == res.status
@@ -71,5 +79,15 @@ def request(method, path, payload = {})
 
       body
     end
+
+    class << self
+      def get_http_methods
+        @http_methods
+      end
+
+      def get_endpoint
+        @endpoint
+      end
+    end
   end
 end

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

lib/sms77/resources/balance.rb

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

lib/sms77/resources/contacts.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+module Sms77::Resources
+  class Contacts < Sms77::Resource
+    @endpoint = Sms77::Endpoint::CONTACTS
+    @http_methods = {
+      :delete => :post,
+      :read => :get,
+      :write => :post,
+    }
+
+    def read(params = {})
+      request(params.merge({ :action => Sms77::Contacts::Action::READ }))
+    end
+
+    def delete(params)
+      request({}, params.merge({ :action => Sms77::Contacts::Action::DEL }))
+    end
+
+    def write(params)
+      request({}, params.merge({ :action => Sms77::Contacts::Action::WRITE }))
+    end
+  end
+end

lib/sms77/resources/hooks.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+module Sms77::Resources
+  class Hooks < Sms77::Resource
+    @endpoint = Sms77::Endpoint::HOOKS
+    @http_methods = {
+      :read => :get,
+      :subscribe => :post,
+      :unsubscribe => :post,
+    }
+
+    def read(params = {})
+      request(params.merge({ :action => Sms77::Hooks::Action::READ }))
+    end
+
+    def subscribe(params)
+      Sms77::Hooks::Validator::subscribe(params)
+
+      request(params.merge({ :action => Sms77::Hooks::Action::SUBSCRIBE }))
+    end
+
+    def unsubscribe(params)
+      Sms77::Hooks::Validator::unsubscribe(params)
+
+      request(params.merge({ :action => Sms77::Hooks::Action::UNSUBSCRIBE }))
+    end
+  end
+end

lib/sms77/resources/journal.rb

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

lib/sms77/resources/lookup.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'sms77/resource'
+module Sms77::Resources
+  class Lookup < Sms77::Resource
+    @endpoint = Sms77::Endpoint::LOOKUP
+    @http_methods = {
+      :cnam => :post,
+      :format => :post,
+      :hlr => :post,
+      :mnp => :post,
+    }
+
+    def cnam(params)
+      request(params.merge({ :type => Sms77::Lookup::Type::CNAM }))
+    end
+
+    def format(params)
+      request(params.merge({ :type => Sms77::Lookup::Type::FORMAT }))
+    end
+
+    def hlr(params)
+      request(params.merge({ :type => Sms77::Lookup::Type::HLR }))
+    end
+
+    def mnp(params)
+      request(params.merge({ :type => Sms77::Lookup::Type::MNP }))
+    end
+  end
+end