phone_number_validation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25053ae25b5a9075d35cf842b287d2ecb3035ff7
+  data.tar.gz: eb7256577f2d4f9381678844c183328dcead145b
+SHA512:
+  metadata.gz: e8b7405a1878568b7eeb6430e9ea09fd911ffefccc57613dba10cd3498613769ac11c7fc047b3923129e6d99ffbb359cb4c38cacd56ebc29a3c124c233ee5050
+  data.tar.gz: 333d107cc79cec6e471ec2c50066182e85e207c9a58d354bd6a9a7d21748f9624f1d709e71c6e9803773db31869169e2d0f7b33cb0a6776d985b33fd30a36d6a

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at github@petermolgaard.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Peter Andreas Moelgaard
+
+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,189 @@
+[![Travis](https://travis-ci.org/pmoelgaard/phone_number_validation.svg)](Travis)
+
+# phone_number_validation (incomplete)
+
+Ruby Library for the numverify API, Global Phone Number Validation & Lookup, [https://numverify.com/](https://numverify.com/)   
+
+---
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'phone_number_validation'
+
+```
+
+And then execute:
+
+```
+$ bundle
+
+```
+
+Or install it yourself as:
+
+```
+$ gem install phone_number_validation
+
+```
+
+---
+
+## Configuration
+
+Before using the numverify API client you have to setup your account and obtain your API Access Key.  
+You can get it by signing up at [https://numverify.com/product](https://numverify.com/product).
+
+---
+
+## API Overview
+All endpoints in the public API is available through this library.
+
+- validate
+- countries (not yet implemented)
+
+---
+
+## Usage
+
+The general API is documented here: [https://numverify.com/documentation](https://numverify.com/documentation).  
+You can find parameters, result set definitions and status codes documented here as well.
+
+In the examples directory you can find demos and samples of general usage of all the API functions.
+
+### Setup
+
+First we require the module
+
+```
+require 'phone_number_validation'
+
+```
+
+Second we instantiate the client
+
+```
+@client = NumverifyLayer::Client.new( [access_key] )
+
+```
+
+#### Required Parameters
+
+###### access_key
+Your unique key that you can find on the dashboard of your account under the numverify account.
+
+#### Optional Parameters
+
+###### Secure (only available for Basic, Pro and Enterprise accounts)
+Boolean value to indicate if the calls to the API should use a secure protocol or insecure (HTTP/HTTPS). Defaults to false (HTTP, insecure).
+
+---
+
+## Validate
+
+Takes a string representing a phone number and validates and analyses it.
+
+###### Define Query
+
+First we get a reference to the string that needs to be detected
+
+```
+number = '+14158586273'
+
+```
+
+Second we define an options object.
+All the options are documented here: [https://numverify.com/documentation](https://numverify.com/documentation)
+
+```
+options = NumverifyLayer::ValidateOptions.new()
+
+```
+
+###### Call Client
+We then place the actual call to the API, passing in the email we wish to check and the options we defined above.
+
+```
+response = @client.validate( [number] [, options] )
+
+``` 
+
+###### Response
+
+If we pass the number ```+14158586273``` as the query argument above, we get the following result:
+
+```
+{
+  "valid": true,
+  "number": "14158586273",
+  "local_format": "4158586273",
+  "international_format": "+14158586273",
+  "country_prefix": "+1",
+  "country_code": "US",
+  "country_name": "United States of America",
+  "location": "Novato",
+  "carrier": "AT&T Mobility LLC",
+  "line_type": "mobile"
+}
+
+```
+---
+
+## Example Application
+
+In the [rootdir]/example directory there is a fully functional application which runs all requests against all the endpoints in the API, the examples above can be seen there as source code.
+
+The example application uses a process.env variable to hold the access key.
+
+---
+
+## Tests
+
+The tests are written using the rspec testing library.  
+**RSpec** [http://rspec.info/](http://rspec.info/)
+
+In order to run the tests, the following environment variables needs to be set:
+
+```
+ACCESS_KEY = [access_key]
+
+```
+
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](mailto:support@apilayer.net?subject=%numverify%5D).
+
+---
+
+## Updates
+Stay up to date by following [@apilayernet](https://twitter.com/apilayernet) on Twitter.
+
+---
+
+## Legal
+
+All usage of the numverify website, API, and services is subject to the [numverify Terms & Conditions](https://numverify.com/terms) and all annexed legal documents and agreements.
+
+---
+
+## Author
+Peter Andreas Moelgaard ([GitHub](https://github.com/pmoelgaard), [Twitter](https://twitter.com/petermoelgaard))
+
+---
+
+## License
+Licensed under the The MIT License (MIT)
+
+Copyright (©) 2016 Peter Andreas Moelgaard & apilayer
+
+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/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 "phone_number_validation"
+
+# 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/example/example_validate.rb

@@ -0,0 +1,30 @@
+require 'dotenv'
+require 'phone_number_validation'
+require 'phone_number_validation/validate_options'
+
+# Load Environment Variables
+Dotenv.load
+
+begin
+
+  # Declare the Client instance passing in the authentication parameters
+  @client = NumverifyLayer::Client.new(ENV['ACCESS_KEY'])
+
+  # Set the number to check
+  number = '+14158586273'
+
+  # We declare the options
+  options = NumverifyLayer::ValidateOptions.new()
+
+  # We make the call to validate
+  response = @client.validate(number, options)
+
+  # If its a success, we print a message to the user
+  if !response.nil?
+    puts 'SUCCESS : Number validated...' << response.to_s
+  end
+
+rescue => e
+  puts e.inspect
+
+end

data/lib/phone_number_validation.rb

@@ -0,0 +1,73 @@
+require "httparty"
+require "hashable"
+require "phone_number_validation/version"
+require "phone_number_validation/validate/validate_options"
+require "phone_number_validation/validate/validate_request"
+require "phone_number_validation/validate/validate_response"
+require "phone_number_validation/validate/validate_exception"
+
+
+module NumverifyLayer
+
+  class Client
+
+    include HTTParty
+
+    base_uri 'apilayer.net/api'
+
+    def initialize(access_key)
+
+      if access_key.nil?
+        raise NumverifyLayer::MissingArgumentException.new 'access_key'
+      end
+
+      @access_key = access_key
+
+    end
+
+
+    def validate(number, options = {})
+
+      if number.nil?
+        raise NumverifyLayer::MissingArgumentException.new 'number'
+        return
+      end
+
+      # Create a shallow copy so we don't manipulate the original reference
+      q = options.dup
+
+      # Populate the Query
+      q.access_key = @access_key
+      q.number = number
+
+      # We then create the Request
+      req = NumverifyLayer::ValidateRequest.new(q)
+
+      #  We create a Hash of the request so we can send it via HTTP
+      req_dto = req.to_dh
+
+      begin
+
+        # We make the actual request
+        res = self.class.get('/validate', req_dto)
+
+        # We ensure that we tap the response so we can use the results
+        res.inspect
+
+        if (res[NumverifyLayer::ValidateResponse::ERROR_EXPR])
+          raise NumverifyLayer::ValidateException.new res[NumverifyLayer::ValidateResponse::ERROR_EXPR]
+        end
+
+        # We just return the parsed binary response
+        return res.parsed_response
+
+      rescue => e
+        puts e.inspect
+        return
+
+      end
+    end
+
+  end
+
+end

data/lib/phone_number_validation/validate/validate_exception.rb

@@ -0,0 +1,15 @@
+require "phone_number_validation/version"
+
+module NumverifyLayer
+
+  class ValidateException < Exception
+
+    attr_accessor :error
+
+    def initialize(error)
+      self.error = error
+    end
+
+  end
+
+end

data/lib/phone_number_validation/validate/validate_options.rb

@@ -0,0 +1,19 @@
+require "phone_number_validation/version"
+
+module NumverifyLayer
+
+  class ValidateOptions
+
+    include Hashable
+
+    attr_accessor :access_key
+
+    attr_accessor :number
+
+    def initialize()
+      @query = nil
+    end
+
+  end
+
+end

data/lib/phone_number_validation/validate/validate_request.rb

@@ -0,0 +1,16 @@
+require "hashable"
+
+module NumverifyLayer
+
+  class ValidateRequest
+
+    include Hashable
+
+    attr_accessor :query
+
+    def initialize(query = {})
+      self.query = query;
+    end
+
+  end
+end

data/lib/phone_number_validation/validate/validate_response.rb

@@ -0,0 +1,17 @@
+require "phone_number_validation/version"
+
+module NumverifyLayer
+
+  class ValidateResponse
+
+    SUCCESS_EXPR = 'success'
+    ERROR_EXPR = 'error'
+
+    def bar
+      SUCCESS_EXPR
+      ERROR_EXPR
+    end
+
+  end
+
+end

data/lib/phone_number_validation/version.rb

@@ -0,0 +1,3 @@
+module NumverifyLayer
+  VERSION = "0.1.0"
+end

data/phone_number_validation.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phone_number_validation/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = "phone_number_validation"
+  spec.version       = NumverifyLayer::VERSION
+  spec.authors       = ["Peter Andreas Moelgaard"]
+  spec.email         = ["github@petermolgaard.com"]
+
+  spec.description   = "Ruby Library for the numverify API, Global Phone Number Validation & Lookup, https://numverify.com/"
+  spec.summary       = "Ruby Library for the numverify API, Global Phone Number Validation & Lookup, https://numverify.com/"
+  spec.homepage      = "https://github.com/pmoelgaard/phone_number_validation"
+
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_runtime_dependency "httparty"
+  spec.add_runtime_dependency "hashable"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "bump"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: phone_number_validation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Andreas Moelgaard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: dotenv
+  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: bump
+  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: Ruby Library for the numverify API, Global Phone Number Validation &
+  Lookup, https://numverify.com/
+email:
+- github@petermolgaard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/example_validate.rb
+- lib/phone_number_validation.rb
+- lib/phone_number_validation/validate/validate_exception.rb
+- lib/phone_number_validation/validate/validate_options.rb
+- lib/phone_number_validation/validate/validate_request.rb
+- lib/phone_number_validation/validate/validate_response.rb
+- lib/phone_number_validation/version.rb
+- phone_number_validation.gemspec
+homepage: https://github.com/pmoelgaard/phone_number_validation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby Library for the numverify API, Global Phone Number Validation & Lookup,
+  https://numverify.com/
+test_files: []