callcredit 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 240b5ca3357002fdecfe94ff1b75791f1b26e987
-  data.tar.gz: c1f970fec32aa70def4515a9b8e8e6ae81748289
+  metadata.gz: 746818ea1841333b6b0c80f83d0f6ca2a9d89c54
+  data.tar.gz: df9ae3730358896b1deb69bc8bf74a9c968f7d4f
 SHA512:
-  metadata.gz: b653cfdaa53a961b7c1316af1f07446fb2ba9dcdfa69f73a646a33b542d8782ca06300aee0522c8dca720573659fb42da8a5a88050bf8a6b3e12b539b04c1941
-  data.tar.gz: 1573d606cd8d7128dc861427614e0758724adec9e1ace6b18a02eedc53633a99f39bab9af1578f60bf1bf830656f72f2cb727dd30b932b10547a4b83f77bbeea
+  metadata.gz: da98781a5a319a2a89f3d5790edaa77618db53692ad79b2db2b56c71f69d7f85dff6c89705f37f240ddf87dce5ce64199dd7d1923f146379ade726fa90b5795b
+  data.tar.gz: 5f61936c7c42d01326d92bf64991f2a7e36ef210db403f399146e00f4298c85ca95d01d8bf9b9fceaeb9e600273fe61effa6567f19fd2bcb258fc87769e43006

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 .bundle
+*.gem

data/README.md

@@ -6,9 +6,18 @@ instead.
 
 ## Usage
 
+### Installation
+
+You don't need this source code unless you want to modify the gem. If you just
+want to use it, you should run:
+
+```ruby
+gem install callcredit
+````
+
 ### Initialising the gem
 Requires your Callcredit credentials. If you don't have any, you'll need to
-call the sales team at [Callcredit](https://callcredit.co.uk).
+call the sales team at [Callcredit](http://callcredit.co.uk).
 
 ```ruby
 Callcredit.configure do |config|
@@ -58,10 +67,30 @@ other checks.
 
 ### Parsing responses
 
-By default the body of Callcredit's response is parsed and returned as a hash.
+Unless you've set the "raw" argument to true in your config, checks called by
+name return a `Response` object and checks called using the generic
+`perform_check` method return a hash.
+
+```ruby
+Callcredit.id_enhanced_check(...)              # => Callcredit::Response
+
+Callcredit.id_enhanced_check(...).input        # => Hash of input params, as
+                                               #    returned by Callcredit
+
+Callcredit.id_enhanced_check(...).result       # => Hash of results
+
+Callcredit.id_enhanced_check(...).full_result  # => Hash of the full XML body
+                                               #    returned by Callcredit
+
+Callcredit.perform_check(...)                  # => Hash of the full XML body
+                                               #    returned by Callcredit
+```
+
 Set the "raw" argument to true if you need the full, unprocessed response
 (including headers, etc.).
 
 ```ruby
 Callcredit.config[:raw] = true
+
+Callcredit.id_enhanced_check(...)              # => Faraday::Response object
 ```

data/callcredit.gemspec

@@ -1,10 +1,10 @@
 require File.expand_path('../lib/callcredit/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.add_runtime_dependency 'faraday'
-  gem.add_runtime_dependency 'faraday_middleware'
-  gem.add_runtime_dependency 'multi_xml'
-  gem.add_runtime_dependency 'nokogiri'
+  gem.add_runtime_dependency 'faraday',             '~> 0.8.0'
+  gem.add_runtime_dependency 'faraday_middleware',  '~> 0.8.2'
+  gem.add_runtime_dependency 'multi_xml',           '~> 0.5.1'
+  gem.add_runtime_dependency 'nokogiri',            '~> 1.4'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'webmock'

data/lib/callcredit/version.rb

@@ -1,3 +1,3 @@
 module Callcredit
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.1'.freeze
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: callcredit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Grey Baker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.2
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement