check_mobi 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17ce81a6d95ab1827f5376bdcd5c3f5af0d2b5b5
+  data.tar.gz: 80cf70bdb1b17927b5053af4ae553bf67ef18e7a
+SHA512:
+  metadata.gz: 3719ffae92e949724bfb0c8236b6acc9a1b44faa1ef0dcbe1f7201dc5e3d64f2b3b40607ef60e3665220603c9d90046c4b211d04fe5d5237838968f29c5dde3d
+  data.tar.gz: e44686ce60dac5cee947bb973b1d43913fe39891611028c1566f257faf5316203cf7c238fa0b089302df36fe407a16133d89fe8cba00f26e8f47684e808a56ca

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/*

data/.ruby-gemset

@@ -0,0 +1 @@
+check_mobi_development

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.0

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                    { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Md. Mazharul Islam Mithu
+
+MIT License
+
+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,37 @@
+# CheckMobi
+
+[![Build Status](https://travis-ci.org/mithucste30/check_mobi.svg?branch=master)](https://travis-ci.org/mithucste30/check_mobi)  [![Coverage Status](https://coveralls.io/repos/github/mithucste30/check_mobi/badge.svg?branch=master)](https://coveralls.io/github/mithucste30/check_mobi?branch=master)
+
+This gem is ruby wrapper for [CheckMobi](https://checkmobi.com) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'check_mobi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install check_mobi
+
+## Usage
+
+To see how to use the gem, goto the project's [wiki](https://github.com/mithucste30/check_mobi/wiki) page.
+
+## Contributing
+
+1. Fork it ( https://github.com/mithucste30/check_mobi/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+MIT License. Copyright 2017 [Md. Mazharul Islam](http://mazharul.me)

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.ruby_opts << "-rubygems"
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/check_mobi.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'check_mobi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "check_mobi"
+  spec.version       = CheckMobi::VERSION
+  spec.authors       = ["Md. Mazharul Islam Mithu"]
+  spec.email         = ["mazharul.freelancer@gmail.com"]
+  spec.summary       = "sample gem"
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8.4"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency 'libnotify'
+  spec.add_development_dependency 'minitest-focus'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+end

data/lib/check_mobi/client.rb

@@ -0,0 +1,65 @@
+require 'net/http'
+require_relative '../check_mobi'
+require_relative 'response'
+require 'json'
+require 'ostruct'
+require 'forwardable'
+
+module CheckMobi
+
+  class Client
+
+    extend Forwardable
+
+    ALLOWED_METHODS = %i[get post delete].freeze
+
+    attr_reader :endpoint, :request, :headers, :response
+    def_delegator :response, :code, :status_code
+    def_delegators :body, :code
+
+    def initialize(options = {})
+      @endpoint = URI(Configuration::DEFAULT_ENDPOINT +
+                          options.fetch(:rel_path, '/'))
+
+      @request = Net::HTTP.const_get(options.fetch(:http_method, :get)
+                                         .to_s.capitalize).new(@endpoint)
+      set_headers
+      set_body options.fetch(:form_data, {})
+    end
+
+    def perform
+      @request.initialize_http_header(@headers)
+
+      @response = Net::HTTP.start(@endpoint.hostname, @endpoint.port, use_ssl: true) do |http|
+        http.request(@request)
+      end
+
+      handle_response
+    end
+
+    def body
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def is_successful
+      code === /^"20\d"$/
+    end
+
+    private
+
+    def set_headers
+      @headers = {}
+      @headers['Content-Type'] = CheckMobi.content_type
+      @headers['Accept'] = CheckMobi.accept_type
+      @headers['Authorization'] = CheckMobi.api_key
+    end
+
+    def set_body(form_data)
+      @request.body = form_data.to_json if @request.request_body_permitted?
+    end
+
+    def handle_response
+      CheckMobi::Response.new self
+    end
+  end
+end

data/lib/check_mobi/configuration.rb

@@ -0,0 +1,44 @@
+module CheckMobi
+  module Configuration
+    VALID_CONNECTION_KEYS = [:endpoint, :user_agent, :method, :content_type, :accept_type].freeze
+    VALID_OPTIONS_KEYS = [:api_key, :format].freeze
+    VALID_CONFIG_KEYS     = (VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS).freeze
+
+    DEFAULT_ENDPOINT = 'https://api.checkmobi.com/v1'.freeze
+
+    DEFAULT_METHOD = :get.freeze
+    DEFAULT_USER_AGENT = "CheckMobi API Ruby Gem".freeze
+
+    DEFAULT_API_KEY = nil.freeze
+    DEFAULT_FORMAT = :json.freeze
+    DEFAULT_CONTENT_TYPE = "application/json".freeze
+    DEFAULT_ACCEPT_TYPE = "application/json".freeze
+    DEFAULT_PLATFORM = 'web'
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.endpoint = DEFAULT_ENDPOINT
+      self.method = DEFAULT_METHOD
+      self.user_agent = DEFAULT_USER_AGENT
+      self.api_key = DEFAULT_API_KEY
+      self.format = DEFAULT_FORMAT
+      self.content_type = DEFAULT_CONTENT_TYPE
+      self.accept_type = DEFAULT_ACCEPT_TYPE
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[*VALID_CONFIG_KEYS.map{|key| [key, send(key)]}.flatten]
+    end
+
+  end #configuration
+end
+

data/lib/check_mobi/core_ext/hash.rb

@@ -0,0 +1,11 @@
+class Hash
+  def symbolize_keys
+    super if defined? Rails
+    self.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+  end
+
+  def stringify_keys
+    super if defined? Rails
+    self.inject({}){|memo,(k,v)| memo[k.to_s] = v; memo}
+  end
+end

data/lib/check_mobi/core_ext/string.rb

@@ -0,0 +1,15 @@
+class String
+  def underscore!
+    super if defined? Rails
+    self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase!
+  end
+
+  def underscore
+    super if defined? Rails
+    dup.underscore!
+  end
+end

data/lib/check_mobi/errors/required_field_error.rb

@@ -0,0 +1,3 @@
+class RequiredFieldError < StandardError
+
+end

data/lib/check_mobi/resource.rb

@@ -0,0 +1,37 @@
+require_relative 'client'
+require_relative '../../lib/check_mobi/shared/class_with_attributes'
+
+module CheckMobi
+  class Resource
+    include ClassWithAttributes
+
+    def perform
+      before_perform
+      client.perform
+    end
+
+    def client
+      Client.new(defaults)
+    end
+
+    private
+
+    ALLOWED_METHODS = Client::ALLOWED_METHODS
+
+    def after_initialize
+      @platform ||= CheckMobi::Configuration::DEFAULT_PLATFORM if instance_variable_defined?(:@platform)
+    end
+
+    def defaults
+      {
+          rel_path: nil,
+          http_method: nil,
+          form_data: nil
+      }
+    end
+
+    def before_perform  # overridden by subclasses
+
+    end
+  end
+end

data/lib/check_mobi/resources/check_number.rb

@@ -0,0 +1,20 @@
+require_relative '../resource'
+
+module CheckMobi
+  module Resources
+    class CheckNumber < Resource
+      attributes :phone_number
+
+      private
+
+      def defaults
+        super.merge!({
+            rel_path: '/checknumber',
+            http_method: ALLOWED_METHODS[1],
+            form_data: {number: phone_number}
+        })
+      end
+    end
+  end
+end
+

data/lib/check_mobi/resources/country_list.rb

@@ -0,0 +1,19 @@
+require_relative '../resource'
+
+
+module CheckMobi
+  module Resources
+    class CountryList < Resource
+
+      private
+
+      def defaults
+        super.merge({
+            rel_path: '/countries',
+            http_method: ALLOWED_METHODS[0]
+        })
+      end
+    end
+  end
+end
+

data/lib/check_mobi/resources/my_account.rb

@@ -0,0 +1,17 @@
+require_relative '../resource'
+
+module CheckMobi
+  module Resources
+    class MyAccount < Resource
+
+      private
+
+      def defaults
+        super.merge!({
+            rel_path: '/my-account',
+            http_method: ALLOWED_METHODS[0]
+        })
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/phone_validation/request_validation.rb

@@ -0,0 +1,22 @@
+require_relative '../../resource'
+
+module CheckMobi
+  module Resources
+    module PhoneValidation
+      class RequestValidation < Resource
+
+        attributes :number, :type, :language, :notification_callback, :platform
+
+        private
+
+        def defaults
+          super.merge!({
+              rel_path: '/validation/request',
+              http_method: ALLOWED_METHODS[1],
+              form_data: to_hash
+          })
+        end
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/phone_validation/validation_status.rb

@@ -0,0 +1,21 @@
+require_relative '../../resource'
+
+module CheckMobi
+  module Resources
+    module PhoneValidation
+      class ValidationStatus < Resource
+
+        attributes :id
+
+        private
+
+        def defaults
+          super.merge!({
+              rel_path: "/validation/status/#{@id}",
+              http_method: ALLOWED_METHODS[0]
+          })
+        end
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/phone_validation/verify_pin.rb

@@ -0,0 +1,23 @@
+require_relative '../../resource'
+
+module CheckMobi
+  module Resources
+    module PhoneValidation
+      class VerifyPin < Resource
+
+        attributes :id, :pin
+        attribute :use_server_hangup, default: false
+
+        private
+
+        def defaults
+          super.merge!({
+              rel_path: '/validation/verify',
+              http_method: ALLOWED_METHODS[1],
+              form_data: to_hash
+           })
+        end
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/prefixes.rb

@@ -0,0 +1,17 @@
+require_relative '../resource'
+
+module CheckMobi
+  module Resources
+    class Prefixes < Resource
+
+      private
+
+      def defaults
+        {
+            rel_path: '/prefixes',
+            http_method: ALLOWED_METHODS[0]
+        }
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/sms/details.rb

@@ -0,0 +1,23 @@
+require_relative '../../resource'
+
+
+module CheckMobi
+  module Resources
+    module SMS
+      class Details < Resource
+
+        attributes :id
+
+        private
+
+        def defaults
+          super.merge!({
+               rel_path: "/sms/#{@id}",
+               http_method: ALLOWED_METHODS[0]
+           })
+        end
+
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/sms/send.rb

@@ -0,0 +1,23 @@
+require_relative '../../resource'
+
+
+module CheckMobi
+  module Resources
+    module SMS
+      class Send < Resource
+
+        attributes :to, :text, :notification_callback, :platform
+
+        private
+
+        def defaults
+          super.merge!({
+              rel_path: '/sms/send',
+              http_method: ALLOWED_METHODS[1],
+              form_data: to_hash
+          })
+        end
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/voice/actions/hangup.rb

@@ -0,0 +1,17 @@
+require_relative '../../../resource'
+require_relative '../events'
+
+module CheckMobi
+  module Resources
+    module Voice
+      module Actions
+
+        class Hangup < Events
+          attributes :reason
+        end
+
+      end
+    end
+  end
+end
+

data/lib/check_mobi/resources/voice/actions/play.rb

@@ -0,0 +1,21 @@
+require_relative '../../../resource'
+require_relative '../events'
+
+module CheckMobi
+  module Resources
+    module Voice
+      module Actions
+        class Play < Events
+          attributes :url, :loop
+
+          private
+
+          def after_initialize
+            @loop ||= 1
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/voice/actions/send_dtmf.rb

@@ -0,0 +1,22 @@
+require_relative '../../../resource'
+require_relative '../events'
+
+module CheckMobi
+  module Resources
+    module Voice
+      module Actions
+
+        class SendDTMF < Events
+          attributes :digits, :async
+
+          private
+
+          def after_initialize
+            @async = true if @async.nil?
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/voice/actions/speak.rb

@@ -0,0 +1,22 @@
+require_relative '../../../resource'
+require_relative '../events'
+
+module CheckMobi
+  module Resources
+    module Voice
+      module Actions
+
+        class Speak < Events
+          attributes :text, :loop, :voice, :language
+
+          def after_initialize
+            @loop ||= 1
+            @voice ||= 'WOMAN'
+            @language ||= 'en-US'
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/voice/actions/wait.rb

@@ -0,0 +1,22 @@
+require_relative '../../../resource'
+require_relative '../events'
+
+module CheckMobi
+  module Resources
+    module Voice
+      module Actions
+
+        class Wait < Events
+          attributes :length
+
+          private
+
+          def after_initialize
+            @length ||= 1
+            super
+          end
+        end
+      end
+    end
+  end
+end