phone_number_validation 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48223b3c9772aa65d633fa6806ded769023e8947
-  data.tar.gz: 47aee733854886a90ea1e4b0ea7285ccbf40571a
+  metadata.gz: 19282847637452cd54d3bb938a59c882b9b5797a
+  data.tar.gz: 75aa8528dcd6c831d1d881d8d5a46a8d4f51be1b
 SHA512:
-  metadata.gz: 2c4448518ff7c11de478f6ebb9a3fd5335717164497bc6251ff95dd95e85467b7b5e566ed06b1a54c5a17794e3ad5ea1c9723267491c76a13e865b81f7dc76cd
-  data.tar.gz: 3dea520f7f561d2a8a72d10b63b4d31dfd04d23930b10f4121a207354445502be9c056227c9f8af9d21ef98096a7b58969a9d98deaea728d214d1fc9ec408299
+  metadata.gz: f2ec31287c90a17286ed46aeffcbdba3b1c9e3f75e7d8081aa51c2e80d1ae2b06542354deb576611445d07b07e680ced654e71f708cb4d6fe583c83d32abdd3d
+  data.tar.gz: e76c9a02d10a96a49ecd8d5da001987670b656aed171ee1f826b51cbb21c8aec92e9d0512aa63503f36346f3db2507526fbccdf1fa36cfa52eef11084172f805

data/README.md

@@ -129,6 +129,47 @@ If we pass the number ```+14158586273``` as the query argument above, we get the
 }
 
 ```
+
+## Countries
+Returns the list of Supported Countries.
+
+###### Define Query
+
+For this endpoint, we dont pass any primary argument, just the control options, so we define an options object.
+There are currently no options for the ```countries``` endpoint, so we could omit it, however we use it with an empty options object here to stay aligned with the standard for the library.
+
+```
+options = NumverifyLayer::CountriesOptions.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.countries([options] )
+
+``` 
+    
+###### Response
+```
+{
+  "AF": {
+    "country_name": "Afghanistan",
+    "dialling_code": "+93"
+  },
+  "AL": {
+    "country_name": "Albania",
+    "dialling_code": "+355"
+  },
+  "DZ": {
+    "country_name": "Algeria",
+    "dialling_code": "+213"
+  },
+  ...
+}
+```
+    
 ---
 
 ## Example Application

data/lib/phone_number_validation/countries/countries_exception.rb

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

data/lib/phone_number_validation/countries/countries_options.rb

@@ -0,0 +1,16 @@
+require "phone_number_validation/version"
+
+module NumverifyLayer
+
+  class CountriesOptions
+
+    include Hashable
+
+    attr_accessor :access_key
+
+    def initialize()
+    end
+
+  end
+
+end

data/lib/phone_number_validation/countries/countries_request.rb

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

data/lib/phone_number_validation/countries/countries_response.rb

@@ -0,0 +1,15 @@
+require "phone_number_validation/version"
+
+module NumverifyLayer
+
+  class CountriesResponse
+
+    ERROR_EXPR = 'error'
+
+    def bar
+      ERROR_EXPR
+    end
+
+  end
+
+end

data/lib/phone_number_validation/version.rb

@@ -1,3 +1,3 @@
 module NumverifyLayer
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/phone_number_validation.rb

@@ -5,7 +5,10 @@ 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"
-
+require "phone_number_validation/countries/countries_options"
+require "phone_number_validation/countries/countries_request"
+require "phone_number_validation/countries/countries_response"
+require "phone_number_validation/countries/countries_exception"
 
 module NumverifyLayer
 
@@ -68,6 +71,42 @@ module NumverifyLayer
       end
     end
 
+    def countries(options = {})
+
+      # Create a shallow copy so we don't manipulate the original reference
+      q = options.dup
+
+      # Populate the Query
+      q.access_key = @access_key
+
+      # We then create the Request
+      req = NumverifyLayer::CountriesRequest.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('/countries', req_dto)
+
+        # We ensure that we tap the response so we can use the results
+        res.inspect
+
+        if (res[NumverifyLayer::CountriesResponse::ERROR_EXPR])
+          raise NumverifyLayer::CountriesException.new res[NumverifyLayer::CountriesResponse::ERROR_EXPR]
+        end
+
+        # We just return the parsed binary response
+        return res.parsed_response
+
+      rescue => e
+        puts e.inspect
+        return
+
+      end
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phone_number_validation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Andreas Moelgaard
@@ -127,6 +127,10 @@ files:
 - bin/setup
 - example/example_validate.rb
 - lib/phone_number_validation.rb
+- lib/phone_number_validation/countries/countries_exception.rb
+- lib/phone_number_validation/countries/countries_options.rb
+- lib/phone_number_validation/countries/countries_request.rb
+- lib/phone_number_validation/countries/countries_response.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