valnzbn 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed4b3415f1c6c2a2a8484dcc7d533c90aa209e7d
-  data.tar.gz: 187dd240f0af524edd476e359b56bbf3ab3bffac
+  metadata.gz: 7ccd1f4b435bc4088a5ed806318d9407653cfeea
+  data.tar.gz: 46e3445400588a2234fecf14f3b511eceb4dc332
 SHA512:
-  metadata.gz: ecd0d32a25f51403a020ae79774a319d8f6d1b3668d41c630e7b5917c514ec5c21d898c5bf10d444750f852bd0834ab105f79efabb4f8454f43fffa109cc9d8c
-  data.tar.gz: 82a4a20513999767032d73936941e99b4eeb29ecb24adf638e11093d7385f5eee826cb963599691cdb0c9e3de51ce43aa054ac93c9bc2b0241b96dee67c3c611
+  metadata.gz: 8d0944c68fb896ad644c610431afcd225d7d2aba35110d0c9f3dfae34d571bb423cc2746cd84fc71b61d74e4d91f6da117df59f6e717819c09aef8ca38a77f0d
+  data.tar.gz: e767c89bd51b7d66b3260fff78eefaad2a11826efa79d15ed9d30935e9816df6649c6dc9d6d07be84b19e8e381525944c5314b0c21e229c22c2a632046d0f2a3

data/README.md

@@ -1,8 +1,7 @@
 # Valnzbn
 
-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/valnzbn`. To experiment with that code, run `bin/console` for an interactive prompt.
+A simple wrapper to check New Zealand business numbers.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,22 +21,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+If you just need to check the format of the ABN, just use:
 
-## Development
+```ruby
+require 'valnzbn'
+
+Valnzbn::Utils.validate_format(number) #=> Boolean
+```
+
+In order to lookup real NZBN, you'll need to get an access token. Once you've got one initialize the gem like this:
+
+```ruby
+require 'valnzbn'
+
+Valnzbn::Lookup.configure do |config|
+  config.access_token = 'your_access_token'
+  config.mode = :production # (optional):production or :sandbox
+  config.cache_host = 'localhost' # (optional) The host of the redis server
+  config.cache_port = '6379' # (optional) The port of the redis server
+end
+```
 
-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.
+`cache_host` and `cache_port` are optional configuration attributes in order to keep a cache on a redis database. The current cache configuration lives up to two hours.
 
-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).
+After that, you can invoke
 
-## Contributing
+```ruby
+Valabn::Lookup.validate(abn) #=> Hash or nil
+
+# or
+
+number = Valabn.new(abn)
+number.exists? #=> Boolean
+number.exists?(details: true) #=> Hash, false or nil
+```
+
+`nil` is a value that should be rarely returned. Just check it if the NZBN API endpoint has issues.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/xxswingxx/valnzbn. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+(The MIT License)
+
+Copyright © 2018 Quaderno
+
+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:
 
-## Code of Conduct
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-Everyone interacting in the Valnzbn project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/xxswingxx/valnzbn/blob/master/CODE_OF_CONDUCT.md).
+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/lib/valnzbn/lookup.rb

@@ -34,7 +34,7 @@ class Valnzbn
     end
 
     def self.validate(number, options = {})
-      url = @@mode == :sandbox ? PRODUCTION_URL : SANDBOX_URL
+      url = @@mode == :sandbox ? SANDBOX_URL : PRODUCTION_URL
       number = number.to_s.gsub(/\W/, '')
 
       if Valnzbn::Utils.valid_format?(number)

data/lib/valnzbn/utils.rb

@@ -5,5 +5,6 @@ class Valnzbn
 
       !!(number =~/\A94\d{11}\z/)
     end
+    alias_method :validate_format, :valid_format?
   end
 end

data/lib/valnzbn/version.rb

@@ -1,3 +1,3 @@
 class Valnzbn
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valnzbn
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - xxswingxx