cortex-snippets-client 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 298a5f8b88cdd5795df1e692afcc3bfe3d9bc963
-  data.tar.gz: fff0646d82724789657034c948a374edbda78f00
+  metadata.gz: d701713c6087c44972b7205b69d4b3abcc879cc2
+  data.tar.gz: bef33a68024253b7f53cdfb2234f83187b6a96ad
 SHA512:
-  metadata.gz: 9325dd3b45975adf9856069d1211e68681eb6b32f75c3981ad60f74500e93900034569163d2ec642503910e3139b23aaf9b461db45e8aa682b6940667e1e446a
-  data.tar.gz: d83148dee459c71e4fc1154638045451b5918e30ef125637cb7338169a2466f45e8084f377ef750031a986cba74b5ffdc628d064ced57ddaadedbaeb99886cad
+  metadata.gz: ce7b2ac62a686d2cfe923150fe6504520460dd9c75a5dae4a76c54ba3cc860cf5ac01681e300acb4ccb1069668b58a77888fb30097dd05c23ab921992e9911fc
+  data.tar.gz: 34409b9ea8153b6887c878c3e298614e848884d0d2bd03e5aa2414e8bbb3cb1f28ed31c278475374b7d776c1d0a16a8bb6c19c1a2681801590b3763a0b08e5c8

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.3.0
+  - 2.3.3
 notifications:
   recipients:
     - ContentEnablementProductTeam@careerbuilder.com

data/CHANGELOG.md

@@ -3,6 +3,8 @@ Version History
     * All Version bumps are required to update this file as well!!
 ----
 
+* 0.8.0 - Add Dynamic Yield Metadata
+* 0.7.0 - Add SEO Robot Metadata
 * 0.6.0 - Set SEO Keyword feed to be an array rather than comma separated String
 * 0.5.3 - Extract a framework-agnostic sanitized_webpage_url method
 * 0.5.2 - Addendum to previous version: fix expiry issues

data/README.md

@@ -1 +1,61 @@
 # cortex-snippets-client-ruby
+
+[![Build Status](https://travis-ci.org/cortex-cms/cortex-snippets-client-ruby.svg?branch=master)](https://travis-ci.org/cortex-cms/cortex-snippets-client-ruby)
+[![Dependency Status](https://gemnasium.com/cortex-cms/cortex-snippets-client-ruby.svg)](https://gemnasium.com/cortex-cms/cortex-snippets-client-ruby)
+
+Ruby client library that provides helpers to assist with loading and displaying Cortex Snippets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cortex-snippets-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cortex-snippets-client
+
+## Configuration
+
+Several environmental variables must be set before using the library:
+
+* `CORTEX_SNIPPET_KEY`
+* `CORTEX_SNIPPET_SECRET`
+* `CORTEX_SNIPPET_BASE_URL`: provide the Cortex API base URL
+* `CORTEX_SNIPPET_ACCESS_TOKEN`: only use this if you have been granted a bearer token (but [don't](https://hueniverse.com/2010/09/29/oauth-bearer-tokens-are-a-terrible-idea/))
+* `CORTEX_SNIPPET_SCOPES`: provide the necessary scopes to obtain Webpage/Snippet data (usually just `view:webpages`)
+
+```ruby
+use OmniAuth::Builder do
+  provider :cortex, ENV['CORTEX_KEY'], ENV['CORTEX_SECRET'], scope: 'scope1, scope2, scope3'
+end
+```
+
+## Rails Helpers
+
+```haml
+= snippet :id => "subhero-button1__text" do
+```
+
+## Sinatra Helpers
+
+## Override Environment
+
+If you would like to change the URLs used by cortex-snippets-client-ruby, override :client_options in the provider config step.
+
+```ruby
+provider :cortex, ENV['CORTEX_KEY'], ENV['CORTEX_SECRET'], scope: 'scope1, scope2, scope3',
+  {
+    :client_options => {
+      :site => 'http://localhost:3000/api/v1',
+      :authorize_url => 'http://localhost:3000/oauth/authorize',
+      :token_url => 'http://localhost:3000/oauth/token'
+    }
+  }
+```
+
+## Caching

data/lib/cortex/snippets/client/helper.rb

@@ -60,6 +60,13 @@ module Cortex
           webpage[:noimageindex]
         end
 
+        def dynamic_yield
+          {
+              sku: webpage[:dynamic_yield_sku],
+              category: webpage[:dynamic_yield_category]
+          }
+        end
+
         private
 
         def webpage

data/lib/cortex/snippets/client/version.rb

@@ -1,7 +1,7 @@
 module Cortex
   module Snippets
     module Client
-      VERSION = '0.7.0'
+      VERSION = '0.8.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cortex-snippets-client
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - CB Content Enablement
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cortex-client
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Provides loading of Cortex snippets for Ruby applications, with some Rails