numverify 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2f93ebdd35fa507e71d888e0bd6d302fef0ba83
-  data.tar.gz: 3cc485275e31dc7c6fe010d28ddef07f26959df6
+  metadata.gz: c914ba8df5e118ce114d415cc8de3238d16f9740
+  data.tar.gz: d16fa6514e2eb8a6e8a6c25f3e11129cfd379f49
 SHA512:
-  metadata.gz: 12f981692413f0a74793f3425dc9abae382943824c6c689a8147e9babc0b8d528295014d1c1f8d46b3b2cf93797fbc21fc825d28218ceac28a59b3e65e37903f
-  data.tar.gz: 5a98e433a6e5a271a0ee6243bd9ea41363fd0f9013e330a5d764715a28f8b23d96bc874e09832faf7c7f873a33db7456613ed5fddb7f40c1c507c9ef987c04ce
+  metadata.gz: 1aa0a4372c4954710a1b966c58a1b9d5977af267ee0d16bcdbf1508bf6d1b8fb5fdfcd2f5ece352d68f80041bfb3c8b85f496669cbb9301652ccda135c4a9a36
+  data.tar.gz: 4d721dcff846b8981d225f6d48b65fc5dd4de0765ee04317a47bf936d4d17936aca0d6df1701098c7d28ec478d492bd216bb5fb28dd6b1e88f91bbfcdcf0a9f1

data/README.md

@@ -1,3 +1,5 @@
+[![CircleCI](https://circleci.com/gh/chronogolf/numverify/tree/master.svg?style=shield&circle-token=a035ff061b42aa7812b0db6e744f2168a2f6eb13)](https://circleci.com/gh/chronogolf/numverify/tree/master) [![Code Climate](https://codeclimate.com/github/chronogolf/numverify/badges/gpa.svg)](https://codeclimate.com/github/chronogolf/numverify) [![Gem Version](https://badge.fury.io/rb/numverify.svg)](https://badge.fury.io/rb/numverify)
+
 # Numverify API Client
 
 This gem is a non-official Ruby Client for Numverify API service.
@@ -20,18 +22,29 @@ Or install it yourself as:
 
 ## Usage
 
-#### Requirments
+#### Requirements
 
 In order to use the client with your Numverify account I'll need to specify you `ACCESS_KEY`
-This can be done on the fly like:
+This can be done through an initializer like:
 ```ruby
-NumverifyClient.validate(... access_key: 'YOUR_ACCESS_KEY')
+NumverifyClient.configure do |config|
+  config.access_key = NUMVERIFY_ACCESS_KEY
+end
 ```
 Or more permanently by using the environment variable
 ```ruby
 ENV['NUMVERIFY_ACCESS_KEY']
 ```
 
+_*Optional*_:  You can also choose to use the service through `https`:
+```ruby
+NumverifyClient.configure do |config|
+  ...
+  config.https = true
+end
+```
+
+
 #### Number Validation:
 
 To validate a phone number just use the `validate` method like:

data/lib/numverify.rb

@@ -1,16 +1,28 @@
 require 'excon'
 require 'json'
 require 'numverify/version'
+require 'numverify/configuration'
 require 'numverify/request'
 
 module NumverifyClient
   class << self
-    def validate(number:, country_code: nil, access_key: ENV['NUMVERIFY_ACCESS_KEY'])
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield configuration
+    end
+
+    def validate(number:, country_code: nil)
       request(build_query(number, country_code, access_key)).perform(method: :get)
     end
 
     private
 
+    def access_key
+      configuration.access_key || ENV['NUMVERIFY_ACCESS_KEY']
+    end
+
     def build_query(number, country_code, access_key)
       {
         number: number,
@@ -20,7 +32,7 @@ module NumverifyClient
     end
 
     def request(query)
-      NumverifyClient::Request.new(query)
+      NumverifyClient::Request.new(query: query, https: configuration.https)
     end
   end
 end

data/lib/numverify/configuration.rb

@@ -0,0 +1,10 @@
+module NumverifyClient
+  class Configuration
+    attr_accessor :access_key, :https
+
+    def initialize
+      @access_key = nil
+      @https = false
+    end
+  end
+end

data/lib/numverify/request.rb

@@ -14,8 +14,8 @@ require 'uri'
 
 module NumverifyClient
   class Request
-    def initialize(query = {})
-      @base_uri   = 'http://apilayer.net'
+    def initialize(query: {}, https: false)
+      @base_uri   = "#{protocol(https)}://apilayer.net"
       @query      = query
       @path       = '/api/validate'
       @connection = Excon.new(@base_uri)
@@ -35,6 +35,10 @@ module NumverifyClient
 
     private
 
+    def protocol(use_https)
+      use_https ? 'https' : 'http'
+    end
+
     def handle_error(error)
       case error['code']
       when 404

data/lib/numverify/version.rb

@@ -1,3 +1,3 @@
 module NumverifyClient
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numverify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Olivier Buffon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-28 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -168,6 +168,7 @@ files:
 - bin/console
 - bin/setup
 - lib/numverify.rb
+- lib/numverify/configuration.rb
 - lib/numverify/errors/api_error.rb
 - lib/numverify/errors/https_access_restriction_error.rb
 - lib/numverify/errors/inactive_user_error.rb