gateway_sdk 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: deefdd9540b059b0be2d1a956a67386ec500e27d
+  data.tar.gz: d1440e2e2db5a06aa86a5b7adf2e862df1fdf7cb
+SHA512:
+  metadata.gz: 571121e662cecfe7de1c76d0226ae3f05f966c9092257df8e87346a807370314770c61c4177c9db6efc9f71c3bbb53dcc4da75428aa7090762ee3caa40726c33
+  data.tar.gz: 47a7ad1a985d1d30000b04539844f404024a30923838f0eda7a6973bda6254f0e9323943a4a3c8cc5b31d1948c6a09560a03d0243c365dd94d014fafd71a1fec

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+--markup-provider redcarpet
+--charset utf-8
+--readme README.md
+-
+README.md

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gateway.gemspec
+gemspec

data/README.md

@@ -0,0 +1,23 @@
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gateway'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gateway
+
+## Usage
+
+Use for sending messages from popular transports: whatsapp, viber, telegram, sms
+Read more: http://chat2desk.com/
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+Dir.glob('tasks/*.rake').each {|r| import r}

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gateway"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gateway_sdk.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gateway/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gateway_sdk"
+  spec.version       = Gateway::VERSION
+  spec.authors       = ["atanych"]
+  spec.email         = ["atanych@gmail.com"]
+
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  # end
+
+  spec.summary       = 'gateway SDK'
+  spec.description   = 'SDK for interaction with gateway'
+  spec.homepage      = 'https://github.com/atanych/gateway_sdk.git'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "yard"
+end

data/lib/gateway.rb

@@ -0,0 +1,16 @@
+Dir["#{File.dirname(__FILE__)}/gateway/**/*.rb"].each {|file| require file }
+
+#
+# SDK for gateway (sending messages and setting params)
+#
+module Gateway
+
+  #
+  # Return root path
+  #
+  # @return [String]
+  #
+  def self.root
+    File.dirname __FILE__
+  end
+end

data/lib/gateway/client.rb

@@ -0,0 +1,74 @@
+require 'json'
+require 'yaml'
+require 'uri'
+require 'rest-client'
+module Gateway
+
+  class << self
+    attr_accessor :config
+  end
+
+  #
+  # Client
+  #
+  class Client
+
+    METHOD_GET  = 'get' # http method GET
+    METHOD_POST = 'post' # http method POST
+
+    attr_accessor :request
+    attr_reader :config_data, :test
+
+    #
+    # Initialize
+    #
+    # @param [Gateway::Requests::CommonRequest] request
+    # @param [TrueClass|FalseClass] test test or production modes
+    #
+    def initialize(request, test = false)
+      Gateway.config = JSON.parse(YAML.load_file("#{Gateway.root}/gateway/config.yml").to_json, object_class: OpenStruct)
+      @request       = request
+      @test          = test
+      request_name = request.class.name.split('::').last
+      @config_data   = Gateway.config.api_methods[request_name]
+      raise Gateway::StandardError.new("fill data in config.yml for method: #{request_name}") unless @config_data
+    end
+
+    #
+    # Send request to gateway and take response from it
+    #
+    # @return [Hash] raw response from gateway
+    #
+    def response
+      # Rails.logger.debug('gateway request: ' + YAML::dump(request))
+      query_params = {r: config_data.route}
+      case config_data.http_method
+        when METHOD_GET
+          query_params.merge! request.attributes
+          response = RestClient.get(url(query_params))
+        when METHOD_POST
+          response = RestClient.post(url(query_params), request.attributes)
+        else
+          raise Gateway::ArgumentError.new("http method #{config_data.http_method} is not supported")
+      end
+      return JSON.parse(response)
+    rescue RestClient::Exception => e
+      response = JSON.parse e.response
+      raise Gateway::StandardError.new(response['message'])
+    end
+
+
+    #
+    # Generate url
+    #
+    # @param [Hash] query_params
+    #
+    # @return [String] url with query params
+    #
+    def url(query_params)
+      url = test ? Gateway.config.urls.test : Gateway.config.urls.production
+      url += '?' + URI.encode_www_form(query_params) unless query_params.empty?
+      url
+    end
+  end
+end

data/lib/gateway/config.yml

@@ -0,0 +1,10 @@
+urls:
+  production: "http://gateway.sms-vote.ru"
+  test: "http://staging.gateway.sms-vote.ru"
+api_methods:
+  SendMessageRequest:
+    route: "scheduler/by-phone-and-transport"
+    http_method: "post"
+  SetProfileRequest:
+    route: "scheduler/profile"
+    http_method: "post"

data/lib/gateway/errors.rb

@@ -0,0 +1,35 @@
+module Gateway
+  #
+  # Standard error
+  #
+  class StandardError < StandardError
+    attr_accessor :message
+
+    #
+    # Initialize
+    #
+    # @param [String] message
+    #
+    def initialize(message)
+      @message = message
+    end
+
+  end
+
+  #
+  # Argument error
+  #
+  class ArgumentError < ArgumentError
+    attr_accessor :message
+
+    #
+    # Initialize
+    #
+    # @param [String] message
+    #
+    def initialize(message)
+      @message = message
+    end
+
+  end
+end

data/lib/gateway/requests/common_request.rb

@@ -0,0 +1,25 @@
+module Gateway
+  module Requests
+
+    #
+    # Common request
+    # All request is needed to inheritance from it
+    #
+    class CommonRequest
+
+      #
+      # Convert instance variables to hash
+      #
+      # @return [Hash]
+      #
+      def attributes
+        hash = {}
+        instance_variables.each do |attr|
+          hash[attr[1..-1]] = instance_variable_get attr
+        end
+        hash
+      end
+
+    end
+  end
+end

data/lib/gateway/requests/send_message_request.rb

@@ -0,0 +1,33 @@
+require File.expand_path('../common_request', __FILE__)
+module Gateway
+  module Requests
+    #
+    # Request to send message via gateway
+    #
+    class SendMessageRequest < Gateway::Requests::CommonRequest
+
+      TRANSPORT_WA    = 'whatsapp' # transport whatsapp
+      TRANSPORT_VIBER = 'viber' # transport viber
+      TRANSPORT_TG    = 'telegram' # transport telegram
+      TRANSPORT_SMS   = 'modem' # transport modem
+
+      attr_accessor :phone, :devicePhone, :body, :image, :transport
+
+      #
+      # Possible transports
+      #
+      def self.possible_transports
+        [TRANSPORT_WA, TRANSPORT_VIBER, TRANSPORT_TG, TRANSPORT_SMS]
+      end
+
+      def transport=(transport)
+        unless self.class.possible_transports.include? transport
+          raise Gateway::ArgumentError.new("transport #{transport} is not supported, use: #{self.class.possible_transports.join(', ')}")
+        end
+        @transport = transport
+      end
+
+    end
+  end
+
+end

data/lib/gateway/requests/set_profile_request.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../common_request', __FILE__)
+module Gateway
+  module Requests
+    #
+    # Request to change settings for whatsapp account via gateway
+    #
+    class SetProfileRequest < CommonRequest
+
+      TYPE_NICKNAME = 1 # nickname
+      TYPE_AVATAR   = 2 # path to avatar
+      TYPE_STATUS   = 3 # status
+
+      attr_accessor :type, :devicePhone, :value
+
+      #
+      # Possible types
+      #
+      def self.possible_types
+        [TYPE_NICKNAME, TYPE_AVATAR, TYPE_STATUS]
+      end
+
+      def type=(type)
+        unless self.class.possible_types.include? type
+          raise Gateway::ArgumentError.new("type #{type} is not supported, use: #{self.class.possible_types.join(', ')}")
+        end
+        @type = type
+      end
+
+    end
+  end
+
+end

data/lib/gateway/version.rb

@@ -0,0 +1,3 @@
+module Gateway
+  VERSION = '0.2.0' # gem version
+end

data/tasks/yard.rake

@@ -0,0 +1,2 @@
+require 'yard'
+YARD::Rake::YardocTask.new

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: gateway_sdk
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- atanych
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SDK for interaction with gateway
+email:
+- atanych@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gateway_sdk.gemspec
+- lib/gateway.rb
+- lib/gateway/client.rb
+- lib/gateway/config.yml
+- lib/gateway/errors.rb
+- lib/gateway/requests/common_request.rb
+- lib/gateway/requests/send_message_request.rb
+- lib/gateway/requests/set_profile_request.rb
+- lib/gateway/version.rb
+- tasks/yard.rake
+homepage: https://github.com/atanych/gateway_sdk.git
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: gateway SDK
+test_files: []
+has_rdoc: