waeasyapi 1.0.0

data/lib/extensions/httparty/hash_conversions.rb

@@ -0,0 +1,44 @@
+require 'httparty'
+
+# :nocov:
+module HTTParty
+  # Extension of HTTParty:HashConversions. Changes made to add index to arrays
+  # https://github.com/jnunemaker/httparty/blob/master/lib/httparty/hash_conversions.rb#L42,L55
+  module HashConversions
+    def self.normalize_keys(key, value)
+      stack = []
+      normalized_keys = []
+
+      if value.respond_to?(:to_ary)
+        if value.empty?
+          normalized_keys << ["#{key}[]", '']
+        else
+          normalized_keys = value.to_ary.flat_map.with_index do
+            |element, index| normalize_keys("#{key}[#{index}]", element)
+          end
+        end
+      elsif value.respond_to?(:to_hash)
+        stack << [key, value.to_hash]
+      else
+        normalized_keys << [key.to_s, value]
+      end
+
+      stack.each do |parent, hash|
+        hash.each do |child_key, child_value|
+          if child_value.respond_to?(:to_hash)
+            stack << ["#{parent}[#{child_key}]", child_value.to_hash]
+          elsif child_value.respond_to?(:to_ary)
+            child_value.to_ary.each_with_index do |v, index|
+              normalized_keys << normalize_keys("#{parent}[#{child_key}][#{index}]", v).flatten
+            end
+          else
+            normalized_keys << normalize_keys("#{parent}[#{child_key}]", child_value).flatten
+          end
+        end
+      end
+
+      normalized_keys
+    end
+  end
+end
+# :nocov:

data/lib/waeasyapi/collection.rb

@@ -0,0 +1,6 @@
+module WAEasyAPI
+  # Collection class handles groups of similar
+  # entities
+  class Collection < Entity
+  end
+end

data/lib/waeasyapi/constants.rb

@@ -0,0 +1,5 @@
+# Version and other constants are defined here
+module WAEasyAPI
+  BASE_URI = 'https://api.waeasyapi.com/v1/'.freeze
+  VERSION = '1.0.0'.freeze
+end

data/lib/waeasyapi/entity.rb

@@ -0,0 +1,46 @@
+require 'json'
+
+module WAEasyAPI
+  # Entity class is the base class for all WAEasyAPI objects
+  # This saves data in a hash internally, and makes it available
+  # via direct methods
+  class Entity
+    attr_reader :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    # This method fakes attr_reader, but uses
+    # the @attributes hash as the source, instead of
+    # instance variables
+    def method_missing(name)
+      if @attributes.key? name.to_s
+        @attributes[name.to_s]
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @attributes.key?(method_name.to_s) || super
+    end
+
+    # Public: Convert the Entity object to JSON
+    # Returns the JSON representation of the Entity (as a string)
+    def to_json(*args)
+      @attributes.to_json(*args)
+    end
+
+    # Mutates the entity in accordance with
+    # the block passed to this construct
+    #
+    # Used to implement bang methods, by calling
+    # the non-bang method in the passed block
+    def with_a_bang
+      mutated_entity = yield
+      @attributes = mutated_entity.attributes
+      mutated_entity
+    end
+  end
+end

data/lib/waeasyapi/errors/bad_request_error.rb

@@ -0,0 +1,14 @@
+require 'waeasyapi/errors/waeasyapi_error'
+
+module WAEasyAPI
+  # Bad request to API. Missing a field or an invalid field.
+  # Error in merchant request. Check the description and correct the request accordingly.
+  class BadRequestError < WAEasyAPI::Error
+    attr_reader :field
+
+    def initialize(code, status, field = nil)
+      super(code, status)
+      @field = field
+    end
+  end
+end

data/lib/waeasyapi/errors/gateway_error.rb

@@ -0,0 +1,7 @@
+require 'waeasyapi/errors/waeasyapi_error'
+
+module WAEasyAPI
+  # Error in Gateway Communication.
+  class GatewayError < WAEasyAPI::Error
+  end
+end

data/lib/waeasyapi/errors/server_error.rb

@@ -0,0 +1,7 @@
+require 'waeasyapi/errors/waeasyapi_error'
+
+module WAEasyAPI
+  # There is some problem with the server
+  class ServerError < WAEasyAPI::Error
+  end
+end

data/lib/waeasyapi/errors/waeasyapi_error.rb

@@ -0,0 +1,11 @@
+module WAEasyAPI
+  # Default Error class for any unknown errors
+  class Error < StandardError
+    attr_reader :code, :status
+
+    def initialize(code = nil, status = nil)
+      @code = code
+      @status = status
+    end
+  end
+end

data/lib/waeasyapi/errors.rb

@@ -0,0 +1,4 @@
+require 'waeasyapi/errors/waeasyapi_error'
+require 'waeasyapi/errors/bad_request_error'
+require 'waeasyapi/errors/gateway_error'
+require 'waeasyapi/errors/server_error'

data/lib/waeasyapi/message.rb

@@ -0,0 +1,26 @@
+require 'waeasyapi/request'
+require 'waeasyapi/entity'
+
+module WAEasyAPI
+  class Message < Entity
+    def self.request
+      WAEasyAPI::Request.new('send')
+    end
+    
+    def self.sendMessage(data={})
+      request.post "message" , data
+    end
+
+    def self.sendTemplate(data={})
+      request.post "template" , data
+    end
+
+    def self.sendMedia(data={})
+      request.post "media" , data
+    end
+
+    def method
+      method_missing(:method)
+    end
+  end
+end

data/lib/waeasyapi/request.rb

@@ -0,0 +1,118 @@
+require 'httparty'
+require 'extensions/httparty/hash_conversions'
+require 'waeasyapi/constants'
+
+module WAEasyAPI
+  # Request objects are used to create fetch
+  # objects, which make requests to the server
+  # using HTTParty
+  class Request
+    include HTTParty
+
+    ssl_ca_file File.dirname(__FILE__) + '/../cacert.pem'
+
+    def initialize(entity_name = nil)
+      self.class.base_uri(WAEasyAPI::BASE_URI)
+      @entity_name = entity_name
+      custom_headers = WAEasyAPI.custom_headers || {}
+      predefined_headers = {
+        'User-Agent' => "WAEasyAPI-Ruby/#{WAEasyAPI::VERSION}; Ruby/#{RUBY_VERSION}"
+      }
+      # Order is important to give precedence to predefined headers
+      headers = custom_headers.merge(predefined_headers)
+      @options = {
+        basic_auth: WAEasyAPI.auth,
+        timeout: 30,
+        headers: headers
+      }
+    end
+
+    def fetch(id)
+      request :get, "/#{@entity_name}/#{id}"
+    end
+
+    def all(options)
+      request :get, "/#{@entity_name}", options
+    end
+
+    def post(url, data = {})
+      request :post, "/#{@entity_name}/#{url}", data
+    end
+
+    def get(url, data = {})
+      request :get, "/#{@entity_name}/#{url}", data
+    end
+    
+    def delete(url)
+      request :delete, "/#{@entity_name}/#{url}"
+    end
+
+    def put(id, data = {})
+      request :put, "/#{@entity_name}/#{id}", data
+    end
+
+    def patch(id, data = {})
+      request :patch, "/#{@entity_name}/#{id}", data
+    end
+
+    def create(data)
+      request :post, "/#{@entity_name}", data
+    end
+
+    def request(method, url, data = {})
+      create_instance raw_request(method, url, data)
+    end
+
+    def raw_request(method, url, data = {}) 
+      case method
+      when :get
+        @options[:query] = data
+      when :post, :put, :patch
+        @options[:body] = data
+      end
+      
+      self.class.send(method, url, @options)
+    end
+
+    # Since we need to change the base route
+    def make_test_request
+      self.class.get WAEasyAPI::TEST_URL, @options
+    end
+
+    # Recursively builds entity instances
+    # out of all hashes in the response object
+    def create_instance(res)
+      response = res.parsed_response
+
+      if response.is_a?(Array)==true || response.to_s.length == 0
+        return response
+      end 
+      
+      # if there was an error, throw it
+      raise_error(response['error'], res.code) if response.nil? || response.key?('error') && res.code !=200
+      # There must be a top level entity
+      begin
+        class_name = response['entity'].split('_').collect(&:capitalize).join
+
+        klass = WAEasyAPI.const_get class_name
+      rescue NameError
+        # Use Entity class if we don't find any
+        klass = WAEasyAPI::Entity
+      end
+      klass.new(response)
+    end
+
+    def raise_error(error, status)
+      # Get the error class name, require it and instantiate an error
+      class_name = error['code'].split('_').map(&:capitalize).join('')
+      args = [error['code'], status]
+      args.push error['field'] if error.key?('field')
+      require "waeasyapi/errors/#{error['code'].downcase}"
+      klass = WAEasyAPI.const_get(class_name)
+      raise klass.new(*args), error['description']
+    rescue NameError, LoadError
+      # We got an unknown error, cast it to Error for now
+      raise WAEasyAPI::Error.new, 'Unknown Error'
+    end
+  end
+end

data/lib/waeasyapi/utility.rb

@@ -0,0 +1,25 @@
+require 'openssl'
+
+module WAEasyAPI
+  # Helper functions are defined here
+  class Utility
+    class << self
+      private
+
+      def secure_compare(a, b)
+        return false unless a.bytesize == b.bytesize
+
+        l = a.unpack('C*')
+        r = 0
+        i = -1
+
+        b.each_byte do |v|
+          i += 1
+          r |= v ^ l[i]
+        end
+
+        r.zero?
+      end
+    end
+  end
+end

data/lib/waeasyapi.rb

@@ -0,0 +1,20 @@
+require 'waeasyapi/errors'
+require 'waeasyapi/message'
+require 'waeasyapi/utility'
+require 'waeasyapi/constants'
+require 'waeasyapi/collection'
+
+# Base WAEasyAPI module
+module WAEasyAPI
+  class << self
+    attr_accessor :auth, :custom_headers
+  end
+
+  def self.setup(key_id, key_secret)
+    self.auth = { username: key_id, password: key_secret }
+  end
+
+  def self.headers=(headers = {})
+    self.custom_headers = headers
+  end
+end

data/waeasyapi-ruby.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', Dir.pwd)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'waeasyapi/constants'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'waeasyapi'
+  spec.version       = WAEasyAPI::VERSION
+  spec.authors       = ['WA Easy API']
+  spec.email         = ['team@waeasyapi.com']
+  spec.summary       = "WAEasyAPI's Ruby API"
+  spec.description   = 'Official ruby bindings for the WAEasyAPI API'
+  spec.homepage      = 'https://waeasyapi.com/'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.14'
+
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'minitest', '~> 5.11'
+  spec.add_development_dependency 'rake', '~> 12.0'
+
+  if RUBY_VERSION >= '2.1.0'
+    # rubocop is only run in the latest ruby build
+    # so we use the latest version and don't switch to a
+    # older version for 1.9.3
+    spec.add_development_dependency 'rubocop', '~> 0.49'
+    spec.add_development_dependency 'webmock', '~> 3.0'
+  else
+    # Webmock 3.0 does not support Ruby 1.9.3
+    spec.add_development_dependency 'webmock', '~> 2.3'
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: waeasyapi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- WA Easy API
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Official ruby bindings for the WAEasyAPI API
+email:
+- team@waeasyapi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".simplecov"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/cacert.pem
+- lib/extensions/httparty/hash_conversions.rb
+- lib/waeasyapi.rb
+- lib/waeasyapi/collection.rb
+- lib/waeasyapi/constants.rb
+- lib/waeasyapi/entity.rb
+- lib/waeasyapi/errors.rb
+- lib/waeasyapi/errors/bad_request_error.rb
+- lib/waeasyapi/errors/gateway_error.rb
+- lib/waeasyapi/errors/server_error.rb
+- lib/waeasyapi/errors/waeasyapi_error.rb
+- lib/waeasyapi/message.rb
+- lib/waeasyapi/request.rb
+- lib/waeasyapi/utility.rb
+- waeasyapi-ruby.gemspec
+homepage: https://waeasyapi.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: WAEasyAPI's Ruby API
+test_files: []