npiregistry 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04fc740aecef41537ebffd00f811f82846f6046e
-  data.tar.gz: 61b77e99cd8dbd2c95efbbe7eba8029af67ab130
+  metadata.gz: b10cc5248d9fe6652e244b0a7a2de2ae87ece676
+  data.tar.gz: '08a50bdacfeac8024f8e96bfa4b378fc72df2b49'
 SHA512:
-  metadata.gz: 45a1833bb32cda005e4d1c5f85d31ecc92161a0a5bdcd2f51edf28e3f8e9d8148d44f4a860c0cb0f52034d0ac98208537960e773d23ea634787035915ecb4fa4
-  data.tar.gz: ee8b1f5ae7becb17b48e8e7527b0b161df02abf13ddba80e3b4b5084bc46fef766a2e055bae2f5e82c061351f960a7fea4ed3782917c05149005a3cefc5a1b57
+  metadata.gz: 89121df3816d8381cc490c9a892dbb414b9ab46139432f648add325d1c2547f36a04d3c5fa9095b67914f9fb503b5f857d640c11ee27ce66b06d46bab3c60e5b
+  data.tar.gz: 54fe0a84e3bf2c18d609cc62880c27a0bb1284941d266fb1d470fc7eed965b1a49b9c91dcecc7cec45f341f95f49033cf2b4921a677e3508b15342e19947be09

data/README.md

@@ -1,8 +1,6 @@
 # Npiregistry
 
-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/npiregistry`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Ruby interface to the NPI registry API | Read Only (https://npiregistry.cms.hhs.gov)
 
 ## Installation
 
@@ -22,7 +20,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Test cases and few conditions code need to add.
+Get details using valid NPI number
+
+```ruby
+Npiregistry.get({number: 1245319599})
+```
+
+Get details using first name and wildcard search 
+
+```ruby
+Npiregistry.get({first_name: 'LAURA'})
+```
+
+or
+
+```ruby
+Npiregistry.get({first_name: '*URA'}) 
+```
+
+Get details using last name and wildcard search
+```ruby
+Npiregistry.get({last_name: 'SAMPLE'})
+```
+
+or
+
+```ruby
+Npiregistry.get({last_name: 'SAM*'}) 
+```
+ 
+Use the following fields to generating valid response.
+
+
+| Fields         |  Description  |  
+| :------------- |:-------------|
+| number                |  Exactly 10 digits
+| enumeration_type      |  NPI-1 or NPI-2 (Other criteria required)    
+| taxonomy_description  |  Exact Description or Exact Specialty or wildcard * after 2 characters
+| first_name            |  Exact name, or wildcard * after 2 characters    Use for type 1
+| last_name             |  Exact name, or wildcard * after 2 characters    Use for type 1
+| organization_name     |  Exact name, or wildcard * after 2 characters    Use for type 2
+| address_purpose       |  LOCATION or MAILING (Other criteria required)
+| city                  |  Exact Name
+| state                 |  2 Characters (Other criteria required)
+| postal_code           |  At least 2 characters, wildcard is implied
+| country_code          |  Exactly 2 characters (if "US", other criteria required)
+| limit                 |  Limit results, default = 10, max = 200
+| skip                  |  Skip first N results, max = 1000
+
+
+
 
 ## Development
 

data/lib/npiregistry/request.rb

@@ -15,7 +15,6 @@ module Npiregistry
 
     def initialize args
       @options = (args[:options] || {}).dup
-      @os_options = OpenStruct.new(@options)
       @url = URL
     end
 
@@ -25,7 +24,7 @@ module Npiregistry
     end
 
     def process_parameters
-      options = @os_options
+      options = OpenStruct.new(@options)
       {
         number: options.number,
         enumeration_type: options.enumeration_type,

data/lib/npiregistry/version.rb

@@ -1,3 +1,3 @@
 module Npiregistry
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: npiregistry
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dharmdip Rathod
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-20 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json