nexmo-saddle-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d05ecb184f084c53bddcff6f9e784d70fc6a9dc
+  data.tar.gz: d9abbd1eb4a85de7a768aa79f325ab256b16e672
+SHA512:
+  metadata.gz: 26e9c5be45709837503bfd863267fe0765ef13be8ebac50d50c246a34514b7c27a10b741ed2ee7f4c42958fc62911d5892b32ea5a41a2679555de139c22965d1
+  data.tar.gz: e0c883e85d485e31280c91a8ef0a4a3bc98eb933045c3b5e302ed1f6958c1f139d6d5ead2f42a6757972b9056fccf1b7f541277b43c0659d0db53da5a009f7d8

data/.gitignore

@@ -0,0 +1,18 @@
+# Ignore the _creds.rb spec file
+spec/_creds.rb
+spec/_creds.stub.rb
+
+# Ignore tempfiles
+*.sw[op]
+.DS_Store
+
+# RVM
+.rvmrc
+
+# Gem stuff
+Gemfile.lock
+*.gem
+
+# IDEs
+.idea
+.project

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec', '~> 2.14.1'
+  gem 'rspec-instafail', '~> 0.2'
+  gem 'pry'
+end

data/README.md

@@ -0,0 +1,5 @@
+# nexmo-client
+ruby client for nexmo api built on saddle
+
+## License
+nexmo-client is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/nexmo-client.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+
+require 'saddle'
+
+require 'nexmo-client/middleware/exception_raiser'
+require 'nexmo-client/version'
+
+
+module NEXMO
+
+  class Client < Saddle::Client
+    #extend NEXMO::Stub
+
+    def initialize args
+        args.each do |k,v|
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+    end
+
+    def self.host
+      @host || 'api.nexmo.com'
+    end
+
+    def self.path_prefix
+      @path_prefix || nil
+    end
+
+    def self.use_ssl
+      true
+    end
+
+    def self.num_retries
+      @num_retries || 2
+    end
+
+    def self.timeout
+      # seconds
+      @timeout || 5
+    end
+
+    def self.request_style
+      @request_style || :json
+    end
+
+    def self.port
+      @port || 443
+    end
+
+    add_middleware({
+      :klass => Middleware::ExceptionRaiser,
+    })
+
+  end
+end

data/lib/nexmo-client/endpoints/verify.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+require 'saddle/endpoint'
+module NEXMO
+  module Endpoints
+
+    class Verify < Saddle::TraversalEndpoint
+    
+      def verify_request(number, brand, params = {}, opts = {})
+        get("json", params.merge({:number => number, :brand => brand}), opts)
+      end
+
+      def check_request(request_id, code, params = {}, opts = {})
+        get("check/json", params.merge({:request_id => request_id, :code => code}), opts)
+      end
+
+    end
+  end
+end

data/lib/nexmo-client/exceptions.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+
+##
+# Exceptions for using the Nexmo client
+# It is recommended that you handle these.
+##
+
+module NEXMO
+
+  class GenericException < StandardError; end
+
+  class TimeoutError < GenericException; end
+
+  # Some problems might take care of themselves if you try again later. Others won't.
+  class TemporaryError < GenericException; end # fire warnings on these
+  class PermanentError < GenericException; end # fire errors on these
+
+  ## Error codes are based upon:
+  ## https://docs.nexmo.com/index.php/verify/search#verify_return_code
+
+  # 1
+  class SystemBusy < TemporaryError; end
+  # 2 - 4, 15 - 18
+  class BadRequest < PermanentError; end
+  # 5 - 7  
+  class SystemError < TemporaryError; end
+  # 8
+  class AccessDenied < PermanentError; end
+  # 9 
+  class InsufficientAppPermission < AccessDenied; end
+  # 101 
+  class NotFound < PermanentError; end
+
+end

data/lib/nexmo-client/middleware/exception_raiser.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+
+require 'faraday'
+require 'nexmo-client/exceptions'
+
+
+module NEXMO
+  module Middleware
+
+    ## Raise beautiful exceptions
+    #
+    class ExceptionRaiser < Faraday::Middleware
+
+      def call(env)
+        begin
+          response = @app.call(env)
+          verify_return_code = response.body.try(:[], 'status').to_i
+
+          if verify_return_code != 0
+            # Error codes are based upon:
+            # https://docs.nexmo.com/index.php/verify/search#verify_return_code         
+
+            # Translate our error code into an exception
+            exception =
+              case verify_return_code
+              when 1
+                NEXMO::SystemBusy
+              when 2..4, 15..18
+                NEXMO::BadRequest
+              when 5..7
+                NEXMO::SystemError
+              when 8
+                NEXMO::AccessDenied
+              when 9
+                NEXMO::InsufficientAppPermission
+              when 101
+                NEXMO::NotFound
+              else
+                NEXMO::GenericException
+              end
+
+            raise exception, response.body.try(:[], 'error_text')
+          end
+          response
+        rescue Saddle::TimeoutError => e
+          raise NEXMO::TimeoutError, e.response
+        end
+      end
+
+    end
+
+  end
+end

data/lib/nexmo-client/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module NEXMO
+  VERSION = '0.0.1'
+end

data/nexmo-client.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/nexmo-client/version', __FILE__)
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'nexmo-saddle-client'
+  s.version       = ::NEXMO::VERSION
+  s.authors       = ['Henry Cai']
+  s.email         = ['minghangcai@gmail.com']
+  s.description   = %q{Nexmo api ruby client}
+  s.summary       = %q{
+    This is a NEXMO api client implemented on Saddle
+  }
+  s.homepage      = 'https://github.com/hcai/nexmo-client.git'
+  s.license       = 'MIT'
+
+  s.require_path  = 'lib'
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_dependency 'saddle', '~> 0.0.49'
+  s.add_dependency 'simple_oauth', '~> 0.2.0'
+end

data/spec/integration/verify_spec.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+###
+# NOTE: This spec will actually hit Nexmo's servers
+###
+
+describe 'NEXMO::Endpoints::Verify' do
+  context "Test integration of verify endpoint" do
+
+    # Skip if the creds aren't setup
+    if defined?(API_KEY) && defined?(API_SECRET)
+
+      before :each do
+        @client = NEXMO::Client.create()
+      end
+
+      it 'sends verify request successfully' do
+        response = @client.verify.verify_request("16503530279", "Thinplify", {:api_key => API_KEY, :api_secret => API_SECRET})
+        response.should be_a(Hash)
+        response['request_id'].should_not be_nil
+        response['status'].should eq('0')
+      end
+
+      it 'should verify successfully' do
+         response = @client.verify.check_request("8bd16ef5d9664bc0bd86592157145efe", "0874", {:api_key => API_KEY, :api_secret => API_SECRET})
+         response.should be_a(Hash)
+         response['status'].should eq('0')
+       end
+
+    else
+      puts "You should put valid creds in _creds.rb"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+require 'nexmo-client'
+
+# Load credentials from ENV if possible, or load from _creds.rb
+if ENV['API_KEY'] && ENV['API_SECRET'] 
+  API_KEY = ENV['API_KEY']
+  API_SECRET = ENV['API_SECRET']
+else
+  begin
+    require '_creds'
+  rescue LoadError
+    puts "Using _creds.stub.rb, create a _creds.rb with actual credentials for a live test."
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: nexmo-saddle-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Henry Cai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: saddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.49
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.49
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Nexmo api ruby client
+email:
+- minghangcai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/nexmo-client.rb
+- lib/nexmo-client/endpoints/verify.rb
+- lib/nexmo-client/exceptions.rb
+- lib/nexmo-client/middleware/exception_raiser.rb
+- lib/nexmo-client/version.rb
+- nexmo-client.gemspec
+- spec/integration/verify_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hcai/nexmo-client.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.2.2
+signing_key: 
+specification_version: 4
+summary: This is a NEXMO api client implemented on Saddle
+test_files:
+- spec/integration/verify_spec.rb
+- spec/spec_helper.rb