dnb-direct-ruby 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd40e7f5776a186418daac09b2549442473f8159
-  data.tar.gz: fe3753e6b6321c44561cd162d55b7a5b88b7727c
+  metadata.gz: d7ceb486fb5488f553e8061470459928a85ba619
+  data.tar.gz: c40f1df0713c644e02c2d0b78202b84d45cde7f7
 SHA512:
-  metadata.gz: b5e649ac887c3932156b1c95ce0f53a4119bd1a30329b65efce86d1f09c91cb2a97e26b2ca8814fa57c26c8e95ae5436b110e4ccc228621a8c3f11585412a6e2
-  data.tar.gz: abc616c1743a9cdf9ae0b2cb90a6dc043cd8ab9618b004af09bf34750d01715b00300c9f576ff39d4de6a0fa8f067bb7dc7c1932bf9a2cf5ce319fb22c1dfe34
+  metadata.gz: 601558a1fd8a0535762f5c040743161d304ce163a66810cdea8abe3a5dab6594231e7c7b980d01e2ed1795110926ed6855d2cee640bbae0ce7e0f3e1e0e98f9d
+  data.tar.gz: 933093b237d2ad9ebaaf1ec7dfe46c9dc462cdb4ba4c908fdcd2bc427691a53c7bf72f139903f36458377d123d8f8d2552b691712636b7652592bb95c22671c3

data/README.md

@@ -1,30 +1,47 @@
 [![Gem Version](https://badge.fury.io/rb/dnb-direct.svg)](https://badge.fury.io/rb/dnb-direct)
 
-# Dnb::Direct
+# DnB Direct API SDK for Ruby
 
-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/dnb/direct`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a Ruby GEM from Dun & Bradstreet that provides simplified, programmatic access to the Direct 1.x, 2.x and Plus(+) APIs.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'dnb-direct'
+gem 'dnb-direct-ruby'
 ```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle install
+```
 
 Or install it yourself as:
-
-    $ gem install dnb-direct
+```
+$ gem install dnb-direct-direct
+```
 
 ## Usage
+In order to fulfill API requests, valid credentials must be supplied. Each of the three families of APIs require a different set of credentials. You will need to be an existing customer with active credentials for the appropriate class of API.
+
+The following illustrates the requirements for each.
+
+### Direct 1.x
+
+```ruby
+DnB::Direct::One.use_credentials "YOURUSERNAME", "YOURPASSWORD", "YOURKEY"
+```
+
+### Direct 2.x
+TODO
+
+### Direct Plus
+```ruby
+DnB::Direct::Plus.use_credentials "YOURAPIKEY", "YOURSECRET"
+```
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -40,4 +57,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/dnb-direct.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jason Ihaia"]
   spec.email         = ["ihaiaj@dnb.com"]
 
-  spec.summary       = 'Write a short summary, because Rubygems requires one.'
-  spec.description   = 'Write a longer description or delete this line.'
+  spec.summary       = 'A Ruby GEM to provide access to DnB APIs.'
+  spec.description   = 'A Ruby GEM to provide access to DnB APIs.'
   spec.homepage      = 'https://developer.dnb.com'
   spec.license       = "MIT"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 

data/docs/ONE.md

@@ -0,0 +1 @@
+# Direct One (1.x)

data/lib/dnb/direct/version.rb

@@ -1,5 +1,5 @@
 module DnB
   module Direct
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: dnb-direct-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Jason Ihaia
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
@@ -128,7 +128,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Write a longer description or delete this line.
+description: A Ruby GEM to provide access to DnB APIs.
 email:
 - ihaiaj@dnb.com
 executables: []
@@ -146,6 +146,7 @@ files:
 - bin/console
 - bin/setup
 - dnb-direct.gemspec
+- docs/ONE.md
 - lib/dnb/direct.rb
 - lib/dnb/direct/mapping.rb
 - lib/dnb/direct/model.rb
@@ -197,5 +198,5 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: Write a short summary, because Rubygems requires one.
+summary: A Ruby GEM to provide access to DnB APIs.
 test_files: []