bootic_client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4311719bc6b53b09e5026c67183f7313c491f48f
-  data.tar.gz: 7f85b7946a404ae8b32019cb05df811ce6a60709
+  metadata.gz: c3577184c13b3c030b8e7bce4bd7e560856564de
+  data.tar.gz: 06ceb2c371d1f60bdb4f246821397789401aa4d9
 SHA512:
-  metadata.gz: 125c0102f1890b005ef8e4ff9ca74f4f597d16c8c542c097edb1e5541ee17c05edc3cd64b0200e7dc61282bd1d5b72dcf8a32e8f3b5f1ce2e0f11ee4907e86f9
-  data.tar.gz: f9b42eeb52e5e031b35d3b2d3c25a20408e0753348c60e358b3fd8fa8f198a21918c8958377a809484f65304ff2b60a1209f1081eb8cc36c75da6ab34e45d187
+  metadata.gz: 5de054c0e2b96d5782e857f962991d27118552d23bd973d581a890d3074a46edb5869c36ff179a142f7b261dadb9d905ab7dae38d7b729d3b600b4bca8bbbff6
+  data.tar.gz: 43a6af6c0fef9c9bb91481b29a94fe788578778ff4a3d76942a56c7ce32992b3d5d7a7a5c05bc63fe0813c6b7837b17871da49f4764ebb55f069eef86663e09d

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/bootic/bootic_client.rb.svg?branch=master)](https://travis-ci.org/bootic/bootic_client.rb)
+[![Gem Version](https://badge.fury.io/rb/bootic_client.svg)](http://badge.fury.io/rb/bootic_client)
 
 ## WORK IN PROGRESS
 
@@ -24,6 +25,8 @@ Or install it yourself as:
 
 ### Configure with you app's credentials
 
+You first must create an OAuth2 Application in your Bootic dashboard. Then configure the client with your `client_id` and `client_secret`.
+
 ```ruby
 BooticClient.configure do |c|
   c.client_id = ENV['BOOTIC_CLIENT_ID']
@@ -41,9 +44,9 @@ bootic = BooticClient.client(:authorized, access_token: 'beidjbewjdiedue...', lo
 
 root = bootic.root
 
-if root.has?(:products)
+if root.has?(:all_products)
   # All products
-  all_products = root.products(q: 'xmas presents')
+  all_products = root.all_products(q: 'xmas presents')
   all_products.total_items # => 23443
   all_products.each do |product|
     puts product.title
@@ -57,7 +60,11 @@ if root.has?(:products)
 end
 ```
 
-## 1. Refresh token flow (web apps)
+## Strategies
+
+The Bootic Client supports different authentication strategies depending on the use case.
+
+### 1. Refresh token flow (web apps)
 
 In this flow you first get a token by authorizing an app. ie. using [omniauth-bootic](https://github.com/bootic/omniauth-bootic)
 
@@ -68,9 +75,12 @@ def client
   end
 end
 ```
+Note how the client takes an optional block. This block will be called with a new access token whenever the old one expires.
+It's up to your code to store this token somewhere.
 
+### 2. User-less flow (client credentials - automated scripts)
 
-## 2. User-less flow (client credentials - automated scripts)
+This flow will first use your client credentials to obtain an access_token if started without one.
 
 ```ruby
 client = BooticClient.client(:client_credentials, scope: 'admin', access_token: some_store[:access_token]) do |new_token|
@@ -78,7 +88,6 @@ client = BooticClient.client(:client_credentials, scope: 'admin', access_token:
 end
 ```
 
-
 ## Cache storage
 
 `BooticClient` honours HTTP caching headers included in API responses (such as `ETag` and `Last-Modified`).

data/lib/bootic_client/strategies/strategy.rb

@@ -5,7 +5,7 @@ module BooticClient
     class Strategy
 
       def initialize(config, client_opts = {}, &on_new_token)
-        @config, @options, @on_new_token = config, client_opts, (on_new_token || Proc.new)
+        @config, @options, @on_new_token = config, client_opts, (on_new_token || Proc.new{})
         raise "MUST include client_id" unless config.client_id
         raise "MUST include client_secret" unless config.client_secret
         raise "MUST include api_root" unless config.api_root

data/lib/bootic_client/version.rb

@@ -1,3 +1,3 @@
 module BooticClient
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/authorized_strategy_spec.rb

@@ -82,6 +82,14 @@ describe 'BooticClient::Strategies::Authorized' do
       end
     end
 
+    context 'without a block' do
+      it 'is valid' do
+        expect{
+          BooticClient.client(:authorized, access_token: 'abc')
+        }.not_to raise_error
+      end
+    end
+
     context 'with valid token' do
       before do
         @root_request = stub_api_root('abc', 200, message: 'Hello!')

data/spec/client_credentials_strategy_spec.rb

@@ -15,6 +15,7 @@ describe 'BooticClient::Strategies::ClientCredentials' do
 
   describe 'with missing client credentials' do
     it 'raises error' do
+      BooticClient.client_id = nil
       expect{
         BooticClient.client(:client_credentials, scope: 'admin')
       }.to raise_error

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootic_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-15 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday