checkmobi-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d15db47851b5f391007395693ee762c44714e530
+  data.tar.gz: dcc7470faabd77d75dc100f0f2a94cc63398577f
+SHA512:
+  metadata.gz: 268920fb5da798f2ede63e282e02890afc5f450b2d95f36166e354530aa07e5d04b8c6fef434cb96126679ec112436c14ce84bf10e1372ce73a8c897bf169739
+  data.tar.gz: 0c4996727bd9411fa362ce65d1f515a621478e05d72d04465b4d3d9e5e9f633f6b0946ff00d8f15b72fa0b9501daf401eaa36e63cec4bb9722ce2e380bade722

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.rake_tasks~
+# rspec failure tracking
+.rspec_status
+.idea

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 hexa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Checkmobi::SDK
+
+This is Checkmobi Ruby Library
+For additional examples, please see official documentation at [https://checkmobi.com/documentation.html#/overview](https://checkmobi.com/documentation.html#/overview) 
+
+[![Build Status](https://travis-ci.org/HEXA-UA/checkmobi-sdk.svg?branch=master)](https://travis-ci.org/HEXA-UA/checkmobi-sdk)
+[![Code Climate](https://codeclimate.com/github/HEXA-UA/checkmobi-sdk/badges/gpa.svg)](https://codeclimate.com/github/HEXA-UA/checkmobi-sdk)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'checkmobi-sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install checkmobi-sdk
+
+## Usage
+
+For all properties accepted by the following methods check [https://checkmobi.com/documentation.html#/overview](https://checkmobi.com/documentation.html#/overview)
+
+```ruby
+require 'checkmobi'
+
+client = Checkmobi::SDK::Client('secret key here')
+api = Checkmobi::SDK::Api.new(client)
+
+# get list of countries & flags
+api.account_details
+
+# get account details
+api.account_details
+
+# get prefixes
+api.prefixes
+
+# checking a number for being valid
+response = api.check_number({ :number => '+number here' })
+
+# validate a number using "Missed call method". (type can be : sms, ivr, cli, reverse_cli)
+response = api.check_number({ :type => 'sms', :number => '+number here' })
+
+# verify a pin for a certain request
+response = api.verify_pin({ :id => "request id here", :pin => "5659" })
+
+#check validation status for a certain request
+response = api.validation_status('request id here');
+
+# send a custom sms
+response = api.send_sms({ :to => "number here", :text => "message here" });
+
+# get details about an SMS
+response = api.sms_details('sms id here');
+
+# place a call
+params = { :from => "+number here", :to => "+number here", :events => [{ :action => "speak", :text => "Hello world", :loop => 2, :language => "en-US" }] };
+response = api.place_call(params);
+
+# get a call details
+response = api.call_details('call id here');
+
+# hangup a call
+response = api.hang_up_call('call id here');
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hexa-ua/checkmobi-sdk.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc 'Build Gem'
+task :build do
+  system 'gem build checkmobi-ruby.gemspec'
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run all tests'
+RSpec::Core::RakeTask.new('spec:all') do |t|
+  # t.rscpec_opts = %w(--colour --fortmat documentation)
+  # t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+
+task :console do
+  sh 'pry --gem'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "checkmobi"
+
+# 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(__FILE__)

data/bin/setup

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

data/checkmobi-sdk.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "checkmobi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'checkmobi-sdk'
+  spec.version       = Checkmobi::SDK::VERSION
+  spec.authors       = ['hexa']
+  spec.email         = ['i.pylypenko@hexa.com.ua']
+
+  spec.summary       = "Checkmobi's Ruby SDK"
+  spec.description   = "Checkmobi's Ruby SDK for interacting with the Checkmobi API."
+  spec.homepage      = 'https://hexa.com.ua'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'pry-byebug', '~> 3.3'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'webmock', '~> 1.22'
+
+  spec.add_dependency 'rest-client', '~> 1.6'
+  spec.add_dependency 'json', '~> 1.8'
+end

data/lib/checkmobi.rb

@@ -0,0 +1,25 @@
+require 'rest_client'
+require 'yaml'
+require 'json'
+
+require 'checkmobi/client'
+require 'checkmobi/api'
+require 'checkmobi/response'
+require 'checkmobi/exceptions/exceptions'
+
+module Checkmobi
+  module SDK
+    class << self
+
+      attr_accessor :api_key
+
+      def configure
+        yield self
+        true
+      end
+
+      alias_method :config, :configure
+
+    end
+  end
+end

data/lib/checkmobi/api.rb

@@ -0,0 +1,59 @@
+module Checkmobi
+  module SDK
+    class Api
+
+      def initialize(client = Checkmobi::SDK::Client.new)
+        @client = client
+      end
+
+      def account_details
+        @client.get '/my-account'
+      end
+
+      def countries
+        @client.get '/countries'
+      end
+
+      def prefixes
+        @client.get '/prefixes'
+      end
+
+      def send_sms(params)
+        @client.post '/sms/send', params
+      end
+
+      def check_number(params)
+        @client.post '/checknumber', params
+      end
+
+      def request_validation(params)
+        @client.post '/validation/request', params
+      end
+
+      def verify_pin(params)
+        @client.post '/validation/verify', params
+      end
+
+      def validation_status(id)
+        @client.get "/validation/status/#{id}"
+      end
+
+      def sms_details(id)
+        @client.get "/sms/#{id}"
+      end
+
+      def place_call(params)
+        @client.post '/call', params
+      end
+
+      def call_details(id)
+        @client.get "/call/#{id}"
+      end
+
+      def hang_up_call(id)
+        @client.delete "/call/#{id}"
+      end
+
+    end
+  end
+end

data/lib/checkmobi/client.rb

@@ -0,0 +1,68 @@
+require 'checkmobi/exceptions/exceptions'
+
+module Checkmobi
+  module SDK
+    class Client
+
+      def initialize(api_key = Checkmobi.api_key,
+                     api_host = 'api.checkmobi.com',
+                     api_version = 'v1')
+
+        endpoint = endpoint_generator(api_host, api_version)
+
+        @http_client = RestClient::Resource.new(endpoint,
+                                                headers: {
+                                                    :Authorization => api_key,
+                                                    :content_type => 'application/json'
+                                                })
+      end
+
+      def post(resource_path, data, headers = {})
+        response = @http_client[resource_path].post(data.to_json, headers)
+        Checkmobi::SDK::Response.new(response)
+      rescue => err
+        raise communication_error err
+      end
+
+      def get(resource_path, params = nil)
+        if params
+          response = @http_client[resource_path].get(params: params)
+        else
+          response = @http_client[resource_path].get()
+        end
+        Checkmobi::SDK::Response.new(response)
+      rescue => err
+        raise communication_error err
+      end
+
+      def put(resource_path, data)
+        response = @http_client[resource_path].put(data.to_json)
+        Checkmobi::SDK::Response.new(response)
+      rescue => err
+        raise communication_error err
+      end
+
+      def delete(resource_path)
+        begin
+          response = @http_client[resource_path].delete
+          Checkmobi::SDK::Response.new(response)
+        rescue => err
+          raise communication_error err
+        end
+      end
+
+      private
+
+      def endpoint_generator(api_host, api_version)
+        scheme = 'https'
+        "#{scheme}://#{api_host}/#{api_version}"
+      end
+
+      def communication_error(e)
+        return CommunicationError.new(e.message, e.response) if e.respond_to? :response
+        CommunicationError.new(e.message)
+      end
+
+    end
+  end
+end

data/lib/checkmobi/exceptions/exceptions.rb

@@ -0,0 +1,19 @@
+module Checkmobi
+  class Error < StandardError
+
+    attr_reader :object
+
+    def initialize(message = nil, object = nil)
+      super(message)
+      @object = object
+    end
+
+  end
+
+  class CommunicationError < Error
+    attr_reader :code
+  end
+
+  class ParseError < Error; end
+
+end

data/lib/checkmobi/response.rb

@@ -0,0 +1,47 @@
+module Checkmobi
+  module SDK
+    class Response
+
+      attr_accessor :body, :code
+
+      def initialize(response)
+        @body = response.body
+        @code = response.code
+      end
+
+      def to_h
+        JSON.parse(@body)
+      rescue => err
+        raise err
+      end
+
+      # Replace @body with Ruby Hash
+      #
+      # @return [Hash] A standard Ruby Hash containing the HTTP result.
+      def to_h!
+        @body = JSON.parse(@body)
+      rescue => err
+        raise ParseError.new(err), err
+      end
+
+      # Return response as Yaml
+      #
+      # @return [String] A string containing response as YAML
+      def to_yaml
+        YAML.dump(to_h)
+      rescue => err
+        raise err
+      end
+
+      # Replace @body with YAML
+      #
+      # @return [String] A string containing response as YAML
+      def to_yaml!
+        @body = YAML.dump(to_h)
+      rescue => err
+        raise ParseError.new(err), err
+      end
+
+    end
+  end
+end

data/lib/checkmobi/version.rb

@@ -0,0 +1,5 @@
+module Checkmobi
+  module SDK
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: checkmobi-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- hexa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Checkmobi's Ruby SDK for interacting with the Checkmobi API.
+email:
+- i.pylypenko@hexa.com.ua
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- checkmobi-sdk.gemspec
+- lib/checkmobi.rb
+- lib/checkmobi/api.rb
+- lib/checkmobi/client.rb
+- lib/checkmobi/exceptions/exceptions.rb
+- lib/checkmobi/response.rb
+- lib/checkmobi/version.rb
+homepage: https://hexa.com.ua
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Checkmobi's Ruby SDK
+test_files: []