check_mobi 1.0.1

data/lib/check_mobi/resources/voice/call.rb

@@ -0,0 +1,26 @@
+require_relative '../../resource'
+require_relative '../../shared/class_with_attributes'
+
+module CheckMobi
+  module Resources
+    module Voice
+
+      class Call < Resource
+
+        attributes :from, :to, :notification_callback, :platform
+        attribute :events, default: []
+
+        private
+
+        def defaults
+          super.merge!({
+              rel_path: '/call',
+              http_method: ALLOWED_METHODS[1],
+              form_data: to_hash
+          })
+        end
+
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/voice/call_details.rb

@@ -0,0 +1,24 @@
+require_relative '../../resource'
+require_relative '../../shared/class_with_attributes'
+
+module CheckMobi
+  module Resources
+    module Voice
+
+      class CallDetails < Resource
+
+        attributes :id
+
+        private
+
+        def defaults
+          super.merge!({
+                           rel_path: "/call/#{@id}",
+                           http_method: ALLOWED_METHODS[0]
+                       })
+        end
+
+      end
+    end
+  end
+end

data/lib/check_mobi/resources/voice/events.rb

@@ -0,0 +1,32 @@
+require_relative '../../shared/class_with_attributes'
+
+module CheckMobi
+  module Resources
+    module Voice
+      class Events
+        include ClassWithAttributes
+
+        readonly_attributes :action
+
+        def to_hash
+          super.merge({action: action})
+        end
+
+        private
+
+        def after_initialize # overridden by subclasses
+          @action = self.class.name.split('::').last.underscore!
+        end
+      end
+    end
+  end
+end
+
+# class << self
+#   attr_reader :required_fields
+#
+#   def mandatory_fields(*args)
+#     @required_fields = []
+#     args.each {|field| @required_fields << field}
+#   end
+# end

data/lib/check_mobi/resources/voice/hangup_call.rb

@@ -0,0 +1,24 @@
+require_relative '../../resource'
+require_relative '../../shared/class_with_attributes'
+
+module CheckMobi
+  module Resources
+    module Voice
+
+      class HangupCall < Resource
+
+        attributes :req_id
+
+        private
+
+        def defaults
+          super.merge!({
+                           rel_path: "/call/#{@req_id}",
+                           http_method: ALLOWED_METHODS[2]
+                       })
+        end
+
+      end
+    end
+  end
+end

data/lib/check_mobi/response.rb

@@ -0,0 +1,22 @@
+require 'ostruct'
+require 'json'
+require 'forwardable'
+require_relative '../../lib/check_mobi/errors/required_field_error'
+require_relative '../../lib/check_mobi/client'
+
+module CheckMobi
+  class Response
+
+    extend Forwardable
+
+    def_delegators :@http_client, :status_code, :is_successful, :body, :response, :code
+    def_delegator :response, :body, :response_body
+
+    alias_method :reason, :body
+
+    def initialize(http_client)
+      raise RequiredFieldError, 'parameter should be a CheckMobi::Client, which is missing' unless http_client.kind_of? CheckMobi::Client
+      @http_client = http_client
+    end
+  end
+end

data/lib/check_mobi/shared/class_with_attributes.rb

@@ -0,0 +1,102 @@
+module ClassWithAttributes
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def attributes(*vars)
+      @attributes ||= []
+
+      vars.uniq.each do |var|
+        @attributes << {name: var, default: nil}
+      end
+
+      send :include, InstanceMethods unless included_modules.include?(InstanceMethods)
+      attr_accessor *vars
+    end
+
+    def readonly_attributes(*vars)
+      @attributes ||= []
+
+      vars.uniq.each do |var|
+        @attributes << {name: var, default: nil}
+      end
+
+      send :include, InstanceMethods unless included_modules.include?(InstanceMethods)
+      attr_reader *vars
+    end
+
+    def attribute(name, options={})
+      @attributes ||= []
+
+      @attributes << ({name: name, default: options[:default]})
+
+      send :include, InstanceMethods unless included_modules.include?(InstanceMethods)
+      attr_accessor name
+    end
+
+    def readonly_attribute(name, options={})
+      @attributes ||= []
+
+      @attributes << ({name: name, default: options[:default]})
+
+      send :include, InstanceMethods unless included_modules.include?(InstanceMethods)
+      attr_reader name
+    end
+
+  end
+
+  module InstanceMethods
+
+    def attributes
+      self.class.instance_variable_get(:@attributes).map{|e| e[:name]}
+    end
+
+    def initialize(options = {})
+      attributes = (self.class.instance_variable_get(:@attributes) || []).map{|e| [e[:name], e[:default].dup]}
+
+      attributes.each do |name, val|
+        if respond_to?("#{name}=") and options.include?(name)
+          value =  options[name]
+        else
+          value = val
+        end
+
+        instance_variable_set("@#{name}", value)
+      end
+
+      after_initialize if respond_to?(:after_initialize, true)
+    end
+
+    def update_attributes(options= {})
+      valid_options = options.select { |k,v| attributes.map(&:to_s).include?(k.to_s) }
+      valid_options.each {|k,v| public_send("#{k}=", v) if respond_to?("#{k}=")}
+    end
+
+    def to_hash
+      h = {}
+      attributes.each do |attr|
+        value = public_send(attr)
+        if value.is_a? Array
+          values = []
+          value.each do |val|
+            if val.respond_to?(:to_hash)
+              values << val.to_hash
+            else
+              values << val
+            end
+          end
+          h[attr] = values
+        elsif value.respond_to?(:to_hash)
+          h[attr] = value.to_hash
+        else
+          h[attr] = value
+        end
+      end
+
+      return h
+    end
+
+  end
+end

data/lib/check_mobi/version.rb

@@ -0,0 +1,3 @@
+module CheckMobi
+  VERSION = "1.0.1"
+end

data/lib/check_mobi.rb

@@ -0,0 +1,45 @@
+require_relative 'check_mobi/configuration'
+require_relative 'check_mobi/core_ext/string'
+require_relative 'check_mobi/core_ext/hash'
+
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+module CheckMobi
+
+  autoload :Client, 'check_mobi/client'
+  autoload :Response, 'check_mobi/response'
+
+  module Resources
+    autoload :CountryList, 'check_mobi/resources/country_list'
+    autoload :CheckNumber, 'check_mobi/resources/check_number'
+    autoload :Prefixes, 'check_mobi/resources/prefixes'
+    autoload :MyAccount, 'check_mobi/resources/my_account'
+
+    module SMS
+      autoload :Send, 'check_mobi/resources/sms/send'
+      autoload :Details, 'check_mobi/resources/sms/details'
+    end
+
+    module PhoneValidation
+      autoload :RequestValidation, 'check_mobi/resources/phone_validation/request_validation'
+      autoload :ValidationStatus, 'check_mobi/resources/phone_validation/validation_status'
+      autoload :VerifyPin, 'check_mobi/resources/phone_validation/verify_pin'
+    end
+
+    module Voice
+      autoload :Call, 'check_mobi/resources/voice/call'
+      autoload :CallDetails, 'check_mobi/resources/voice/call_details'
+      autoload :HangupCall, 'check_mobi/resources/voice/hangup_call'
+
+      module Actions
+        autoload :Hangup, 'check_mobi/resources/voice/actions/hangup'
+        autoload :Play, 'check_mobi/resources/voice/actions/play'
+        autoload :SendDTMF, 'check_mobi/resources/voice/actions/send_dtmf'
+        autoload :Speak, 'check_mobi/resources/voice/actions/speak'
+        autoload :Wait, 'check_mobi/resources/voice/actions/wait'
+      end
+    end
+  end
+
+  extend Configuration
+end

data/test/check_mobi/check_mobi_test.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+describe CheckMobi do
+  it 'should have a version' do
+    CheckMobi::VERSION.wont_be_nil
+  end
+end

data/test/check_mobi/client_test.rb

@@ -0,0 +1,64 @@
+require 'helper'
+require 'json'
+
+describe CheckMobi::Client do
+	let(:form_data) { {'sample_data': 1} }
+
+  describe 'In Common' do
+    before do
+      CheckMobi.configure do |c|
+        c.content_type = 'json'
+        c.accept_type = 'json'
+        c.api_key = '1234567'
+      end
+
+      @client = CheckMobi::Client.new()
+    end
+
+    after do
+      CheckMobi.reset
+    end
+
+    it 'should have valid headers' do
+      @client.headers['Content-Type'].must_equal CheckMobi.content_type
+      @client.headers['Accept'].must_equal CheckMobi.accept_type
+      @client.headers['Authorization'].must_equal CheckMobi.api_key
+    end
+  end
+
+	describe 'On HTTP GET' do
+
+		before do
+    		@client = CheckMobi::Client.new(http_method: :get)
+    		@request = @client.request
+    end
+
+  	it 'should return instance of net/http/get instance' do
+  			@request.must_be_instance_of Net::HTTP::Get
+  	end
+
+  	it 'wont accept/return form_data' do
+			  @client.send(:set_body, form_data)
+			  @request.body.must_equal nil
+    end
+
+  end
+
+  describe "On HTTP POST" do
+
+		before do
+			@client = CheckMobi::Client.new(http_method: :post)
+			@request = @client.request
+		end
+
+		it "should return instance of net/http/get instance" do
+  			@request.must_be_instance_of Net::HTTP::Post
+  		end
+
+		it "should accept/return form_data" do
+			@client.send(:set_body, form_data)
+      JSON.parse(@request.body).symbolize_keys.must_equal form_data
+    end
+
+  end
+end

data/test/check_mobi/configuration_test.rb

@@ -0,0 +1,55 @@
+require 'helper'
+
+describe 'configuration' do
+
+    before do
+      CheckMobi.reset
+    end
+
+    describe '.api_key' do
+      it 'should return default key' do
+          CheckMobi.api_key.must_equal CheckMobi::Configuration::DEFAULT_API_KEY
+      end
+    end
+
+    describe '.format' do
+      it 'should return default fomat' do
+          CheckMobi.format.must_equal CheckMobi::Configuration::DEFAULT_FORMAT
+      end
+    end
+
+    describe '.method' do
+      it 'should return default method' do
+          CheckMobi.method.must_equal CheckMobi::Configuration::DEFAULT_METHOD
+      end
+    end
+
+    describe '.user_agent' do
+      it 'should return default user agent' do
+        CheckMobi.user_agent.must_equal CheckMobi::Configuration::DEFAULT_USER_AGENT
+      end
+    end
+
+    CheckMobi::Configuration::VALID_CONFIG_KEYS.each do |key|
+      describe ".#{key}" do
+        it 'should return the default value' do
+          CheckMobi.send(key).must_equal CheckMobi::Configuration.const_get("DEFAULT_#{key.upcase}")
+        end
+      end
+    end
+
+    describe '.configure' do
+      CheckMobi::Configuration::VALID_CONFIG_KEYS.each do |key|
+        it "should set the #{key}" do
+          CheckMobi.configure do |config|
+            config.send("#{key}=", key)
+            CheckMobi.send(key).must_equal key
+          end # CheckMobi.configure
+        end # describe 'it should set the key'
+      end # CheckMobi::Configuration::VALID_CONFIG_KEYS
+    end # describe '.configure'
+
+    after do
+      CheckMobi.reset
+    end
+end

data/test/check_mobi/core_ext/hash_test.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+describe Hash do
+  it 'should symbolize_keys' do
+    {'a': 1, "b": 2}.symbolize_keys.must_equal({a: 1, b: 2})
+  end
+end

data/test/check_mobi/core_ext/string_test.rb

@@ -0,0 +1,27 @@
+require 'helper'
+require_relative '../../../lib/check_mobi/core_ext/string'
+
+describe String do
+
+  it 'should respond to underscore' do
+    'TheSampleClass'.must_respond_to(:underscore)
+    'TheSampleClass'.must_respond_to(:underscore!)
+  end
+
+  it 'should underscore a class string name' do
+    'TheSampleClass'.underscore.must_equal 'the_sample_class'
+    'TheSampleClass'.underscore!.must_equal 'the_sample_class'
+  end
+
+  it 'should put / on namespacing' do
+    'SuperTop::Parent::TheSampleClass'.underscore.must_equal 'super_top/parent/the_sample_class'
+  end
+
+  it 'should preserve /' do
+    'SuperTop/Parent/TheSampleClass'.underscore.must_equal 'super_top/parent/the_sample_class'
+  end
+
+  it 'should replace - with _' do
+    'Super-Top/Parent/The-Sample-Class'.underscore.must_equal 'super_top/parent/the_sample_class'
+  end
+end

data/test/check_mobi/resources/check_number_test.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+describe CheckMobi::Resources::CheckNumber do
+  before do
+    CheckMobi.api_key = ENV['API_KEY']
+    @endpoint = 'https://api.checkmobi.com/v1/checknumber'
+    @resource_class = CheckMobi::Resources::CheckNumber
+    stub_post_request(@endpoint)
+  end
+
+  it 'should request without phone number' do
+    resource = @resource_class.new
+    response = resource.perform
+    assert_requested(:post, @endpoint, headers: headers_with_authorization, body: {number: nil}.to_json, times: 1)
+  end
+
+  it 'should request with invalid phone number' do
+    resource = @resource_class.new(phone_number: '000000000')
+    resource.perform
+    assert_requested(:post, @endpoint, headers: headers_with_authorization, body: {number: '000000000'}.to_json, times: 1)
+  end
+
+  it 'should request without api key' do
+    CheckMobi.api_key = nil
+    resource = @resource_class.new(phone_number: ENV['PHONE_NUMBER'])
+    resource.perform
+    assert_requested(:post, @endpoint, headers: headers_without_authorization, body: {number: ENV['PHONE_NUMBER']}.to_json, times: 1)
+  end
+
+  it 'should request with api key and phone number' do
+    resource = @resource_class.new(phone_number: ENV['PHONE_NUMBER'])
+    resource.perform
+    assert_requested(:post, @endpoint, headers: headers_with_authorization, body: {number: ENV['PHONE_NUMBER']}.to_json, times: 1)
+  end
+end

data/test/check_mobi/resources/country_test.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+describe CheckMobi::Resources::CountryList do
+  before do
+    @endpoint = 'https://api.checkmobi.com/v1/countries'
+    stub_get_request(@endpoint)
+  end
+
+  it "should request country list" do
+    @resource = CheckMobi::Resources::CountryList.new
+    @resource.perform
+    assert_requested(:get, @endpoint, headers: headers_without_authorization, times: 1)
+  end
+end

data/test/check_mobi/resources/my_account_test.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+describe CheckMobi::Resources::MyAccount do
+  before do
+    CheckMobi.api_key = ENV['API_KEY']
+    @endpoint = 'https://api.checkmobi.com/v1/my-account'
+    stub_get_request(@endpoint)
+  end
+
+  it 'should fetch account info with valid api_key' do
+    resource = CheckMobi::Resources::MyAccount.new
+    resource.perform
+    assert_requested(:get, @endpoint, headers: headers_with_authorization, times: 1)
+  end
+end

data/test/check_mobi/resources/phone_validation/request_validation_test.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+describe CheckMobi::Resources::PhoneValidation::RequestValidation do
+  before do
+    @endpoint = 'https://api.checkmobi.com/v1/validation/request'
+
+    CheckMobi.configure do |c|
+      c.api_key = ENV['API_KEY']
+    end
+
+    @resource = CheckMobi::Resources::PhoneValidation::RequestValidation.new(
+        number: ENV['PHONE_NUMBER'],
+        type: 'cli',
+        language: 'en-US'
+    )
+
+    stub_post_request(@endpoint)
+  end
+
+  describe 'phone validation resource' do
+
+    it 'should request with no phone number' do
+      @resource.number = nil
+      @resource.perform
+      assert_requested(:post,
+                       @endpoint,
+                       headers: headers_with_authorization,
+                       body: { number: nil, type: 'cli', language: 'en-US', notification_callback:nil, platform: "web"},
+                       times: 1)
+    end
+
+    it 'should request with all valid fields' do
+      CheckMobi.api_key = ENV['API_KEY']
+      @resource.type = 'reverse_cli'
+      @resource.perform
+      assert_requested(:post,
+                       @endpoint,
+                       headers: headers_with_authorization,
+                       body: { number: ENV['PHONE_NUMBER'], type: 'reverse_cli', language: 'en-US',
+                               notification_callback:nil, platform: "web"},
+                       times: 1)
+    end
+
+  end
+
+
+end

data/test/check_mobi/resources/phone_validation/validation_status_test.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+describe CheckMobi::Resources::PhoneValidation::ValidationStatus do
+  before do
+    @id = 'xxxxxx'
+    @endpoint = "https://api.checkmobi.com/v1/validation/status/#{@id}"
+
+    CheckMobi.configure do |c|
+      c.api_key = ENV['API_KEY']
+    end
+
+    @resource = CheckMobi::Resources::PhoneValidation::ValidationStatus.new
+    stub_get_request(@endpoint)
+  end
+
+  it 'validation status resource should request properly' do
+    @resource.id = @id
+    @resource.perform
+    assert_requested(:get,
+                     @endpoint,
+                     headers: headers_with_authorization,
+                     times: 1)
+  end
+end

data/test/check_mobi/resources/phone_validation/verify_pin_test.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+describe CheckMobi::Resources::PhoneValidation::VerifyPin do
+  before do
+    @pin = 'xxxxxx'
+    @id = 'sid'
+    @endpoint = 'https://api.checkmobi.com/v1/validation/verify'
+
+    CheckMobi.configure do |c|
+      c.api_key = ENV['API_KEY']
+    end
+
+    @resource = CheckMobi::Resources::PhoneValidation::VerifyPin.new
+    stub_post_request(@endpoint)
+  end
+
+  it 'validation status resource should request properly' do
+    @resource.update_attributes(pin: @pin, id: @id)
+    @resource.perform
+    assert_requested(:post,
+                     @endpoint,
+                     body: {pin: @pin, id: @id, use_server_hangup: false},
+                     headers: headers_with_authorization,
+                     times: 1)
+  end
+
+end

data/test/check_mobi/resources/prefix_test.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+describe CheckMobi::Resources::Prefixes do
+  before do
+    CheckMobi.api_key = ENV['API_KEY']
+    @endpoint = 'https://api.checkmobi.com/v1/prefixes'
+  end
+
+  it 'should fetch prefixes' do
+    stub_get_request(@endpoint)
+    resource = CheckMobi::Resources::Prefixes.new
+    resource.perform
+    assert_requested(:get, @endpoint, headers: headers_with_authorization, times: 1)
+  end
+end

data/test/check_mobi/resources/sms/detail_test.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+describe CheckMobi::Resources::SMS::Details do
+  before do
+    @endpoint = "https://api.checkmobi.com/v1/sms/"
+    @sms_id = '123456'
+    CheckMobi.api_key = ENV['API_KEY']
+    @resource_class = CheckMobi::Resources::SMS::Details
+    stub_get_request(@endpoint)
+    stub_get_request(@endpoint + @sms_id)
+  end
+
+  it 'with invalid id' do
+    client = @resource_class.new(id: nil)
+    client.perform
+    assert_requested(:get, @endpoint, headers: headers_with_authorization, times: 1)
+  end
+
+  it 'sms details fetching should be successful' do
+    client = @resource_class.new(id: @sms_id)
+    client.perform
+    assert_requested(:get, @endpoint + @sms_id, headers: headers_with_authorization, times: 1)
+  end
+end