numverify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95a8e6ad4810a2cc64032f65558d0f47fe98c3f8
+  data.tar.gz: a093132bcc6db581d0ab39d90359e1b4c57afc80
+SHA512:
+  metadata.gz: 96e19ffdb17c71d866b6203ca3f7e02fea5ec81c3e9ec734a15a48eca66648d88e0efcdb61cb9849c0f954d4ade67697eaa406fbf00ecadc380d61ac965c1416
+  data.tar.gz: 7c2dc61c55487c1373f008a586fb5f8165bf77366d3fd403afcdcb6e9428b660220af76c288378c941f8faacc73e06996d88bd9b27e1a9994496a2b201cd3696

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/.rubocop.yml

@@ -0,0 +1,15 @@
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/**/*'

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Olivier Buffon
+
+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,41 @@
+# Numverify
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/numverify`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'numverify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install numverify
+
+## Usage
+
+TODO: Write usage instructions 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/[USERNAME]/numverify.
+
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'numverify'
+
+# 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,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/lib/numverify.rb

@@ -0,0 +1,26 @@
+require 'excon'
+require 'json'
+require 'numverify/version'
+require 'numverify/request'
+
+module NumverifyClient
+  class << self
+    def validate(number:, country_code: nil, access_key: ENV['NUMVERIFY_ACCESS_KEY'])
+      request(build_query(number, country_code, access_key)).perform(method: :get)
+    end
+
+    private
+
+    def build_query(number, country_code, access_key)
+      {
+        number: number,
+        country_code: country_code,
+        access_key: access_key
+      }
+    end
+
+    def request(query)
+      NumverifyClient::Request.new(query)
+    end
+  end
+end

data/lib/numverify/errors/api_error.rb

@@ -0,0 +1,4 @@
+module NumverifyClient
+  class APIError < NumverifyClientError
+  end
+end

data/lib/numverify/errors/https_access_restriction_error.rb

@@ -0,0 +1,4 @@
+module NumverifyClient
+  class HttpsAccessRestrictionError < NumverifyClientError
+  end
+end

data/lib/numverify/errors/inactive_user_error.rb

@@ -0,0 +1,4 @@
+module NumverifyClient
+  class InactiveUserError < NumverifyClientError
+  end
+end

data/lib/numverify/errors/invalid_access_key_error.rb

@@ -0,0 +1,4 @@
+module NumverifyClient
+  class InvalidAccessKeyError < NumverifyClientError
+  end
+end

data/lib/numverify/errors/invalid_api_function_error.rb

@@ -0,0 +1,4 @@
+module NumverifyClient
+  class InvalidApiFunctionError < NumverifyClientError
+  end
+end

data/lib/numverify/errors/invalid_country_code_error.rb

@@ -0,0 +1,4 @@
+module NumverifyClient
+  class InvalidCountryCodeError < NumverifyClientError
+  end
+end

data/lib/numverify/errors/no_phone_number_error.rb

@@ -0,0 +1,4 @@
+module NumverifyClient
+  class NoPhoneNumberError < NumverifyClientError
+  end
+end

data/lib/numverify/errors/non_numeric_phone_number_error.rb

@@ -0,0 +1,4 @@
+module NumverifyClient
+  class NonNumericPhoneNumberError < NumverifyClientError
+  end
+end

data/lib/numverify/errors/not_found_error.rb

@@ -0,0 +1,4 @@
+module NumverifyClient
+  class NotFoundError < NumverifyClientError
+  end
+end

data/lib/numverify/errors/numverify_client_error.rb

@@ -0,0 +1,13 @@
+module NumverifyClient
+  class NumverifyClientError < StandardError
+    attr_reader :message
+
+    def initialize(message)
+      @message = message
+    end
+
+    def to_s
+      message
+    end
+  end
+end

data/lib/numverify/errors/usage_limit_error.rb

@@ -0,0 +1,4 @@
+module NumverifyClient
+  class UsageLimitError < NumverifyClientError
+  end
+end

data/lib/numverify/request.rb

@@ -0,0 +1,63 @@
+require 'numverify/errors/numverify_client_error'
+require 'numverify/errors/api_error'
+require 'numverify/errors/https_access_restriction_error'
+require 'numverify/errors/inactive_user_error'
+require 'numverify/errors/invalid_access_key_error'
+require 'numverify/errors/invalid_api_function_error'
+require 'numverify/errors/invalid_country_code_error'
+require 'numverify/errors/no_phone_number_error'
+require 'numverify/errors/non_numeric_phone_number_error'
+require 'numverify/errors/not_found_error'
+require 'numverify/errors/usage_limit_error'
+require 'numverify/result'
+require 'uri'
+
+module NumverifyClient
+  class Request
+    def initialize(query = {})
+      @base_uri   = 'http://apilayer.net'
+      @query      = query
+      @path       = '/api/validate'
+      @connection = Excon.new(@base_uri)
+    end
+
+    attr_reader :connection, :path, :query
+
+    def perform(**args)
+      response = connection.request(args.merge(path: path, query: query))
+      parsed_response = JSON.parse(response.body)
+      if parsed_response.key?('error')
+        handle_error(parsed_response['error'])
+      else
+        NumverifyClient::Result.new(parsed_response)
+      end
+    end
+
+    private
+
+    def handle_error(error)
+      case error['code']
+      when 404
+        raise NotFoundError, error['info']
+      when 101
+        raise InvalidAccessKeyError, error['info']
+      when 103
+        raise InvalidApiFunctionError, error['info']
+      when 210
+        raise NoPhoneNumberError, error['info']
+      when 211
+        raise NonNumericPhoneNumberError, error['info']
+      when 310
+        raise InvalidCountryCodeError, error['info']
+      when 104
+        raise UsageLimitError, error['info']
+      when 105
+        raise HttpsAccessRestrictionError, error['info']
+      when 102
+        raise InactiveUserError, error['info']
+      else
+        raise APIError, error['info']
+      end
+    end
+  end
+end

data/lib/numverify/result.rb

@@ -0,0 +1,27 @@
+module NumverifyClient
+  class Result
+    def initialize(data = {})
+      convert_to_obj(data)
+    end
+
+    def attributes
+      instance_variables.each_with_object({}) do |instance_variable, h|
+        h[instance_variable[1..instance_variable.length]] = instance_variable_get(instance_variable)
+      end
+    end
+
+    def to_json
+      attributes.to_json
+    end
+
+    private
+
+    def convert_to_obj(h)
+      h.each do |key, value|
+        self.class.send(:attr_accessor, key)
+        instance_variable_set("@#{key}", value)
+        convert_to_obj(value) if value.is_a? Hash
+      end
+    end
+  end
+end

data/lib/numverify/version.rb

@@ -0,0 +1,3 @@
+module NumverifyClient
+  VERSION = '0.1.0'.freeze
+end

data/numverify.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'numverify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'numverify'
+  spec.version       = NumverifyClient::VERSION
+  spec.authors       = ['Olivier Buffon']
+  spec.email         = ['olivier@chronogolf.ca']
+
+  spec.summary       = 'API Client for Numverify services'
+  spec.description   = 'Numverify: Global Phone Number Validation & Lookup JSON API'
+  spec.homepage      = 'https://github.com/chronogolf/numverify'
+  spec.license       = 'MIT'
+
+  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_dependency('excon', '~> 0.45.4')
+  spec.add_dependency('json', '~> 1.8.3')
+
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('pry')
+  spec.add_development_dependency('rubocop')
+  spec.add_development_dependency('bundler-audit')
+  spec.add_development_dependency('rspec_junit_formatter')
+  spec.add_development_dependency('webmock')
+  spec.add_development_dependency('vcr')
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: numverify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Olivier Buffon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: pry
+  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: rubocop
+  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: bundler-audit
+  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: rspec_junit_formatter
+  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: webmock
+  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: vcr
+  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: 'Numverify: Global Phone Number Validation & Lookup JSON API'
+email:
+- olivier@chronogolf.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/numverify.rb
+- lib/numverify/errors/api_error.rb
+- lib/numverify/errors/https_access_restriction_error.rb
+- lib/numverify/errors/inactive_user_error.rb
+- lib/numverify/errors/invalid_access_key_error.rb
+- lib/numverify/errors/invalid_api_function_error.rb
+- lib/numverify/errors/invalid_country_code_error.rb
+- lib/numverify/errors/no_phone_number_error.rb
+- lib/numverify/errors/non_numeric_phone_number_error.rb
+- lib/numverify/errors/not_found_error.rb
+- lib/numverify/errors/numverify_client_error.rb
+- lib/numverify/errors/usage_limit_error.rb
+- lib/numverify/request.rb
+- lib/numverify/result.rb
+- lib/numverify/version.rb
+- numverify.gemspec
+homepage: https://github.com/chronogolf/numverify
+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: API Client for Numverify services
+test_files: []