buttercms-ruby 1.0.10 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf196fb4aad8f73afc7b5553f4db65169c71fc2c
-  data.tar.gz: ccf34d34ff943a7cd62357463f2c0d6c6c404e0b
+  metadata.gz: 8a5b25e75cd089178453db6e0bf8998d234dd5c4
+  data.tar.gz: cf916ea47c139bf2fd8ce739fdac79785d59da6d
 SHA512:
-  metadata.gz: ca83066a05a7acd2142fc81bd7cecf2b6cb5ecae8b0b84598f7401215bde14a8d9b40000dde1c1e71d2cd2c7aa91cb77a0380781a9e1ab7fd9cdf5aa2e9f9e22
-  data.tar.gz: d815c60c62f9ca9690d6a64e0393f19d500e00157cf36aadce71d676d69d3c51bc2275bd6f5cd31a313f60b116c17be7a01a071f0b196da43d6eb4dde9cb8a27
+  metadata.gz: 24878819c0724a9c61c7cf99cab33904c8ccbb1451dd629f10b24e49214d6bc1927ed3d53768efb7a1d3aa9c97314d44fdb4d24efc07c4616608aa482cdcb22b
+  data.tar.gz: ec48e2d3483619a45cdfac7cc5602e9a2984288539d1fb8e59492b9a6e77d5b1e3f463b8dad536dd2c98017acd3cd316ce41511189a8c8a8c9508eb797ce2191

data/.gitignore

@@ -17,4 +17,6 @@ test/version_tmp
 tmp
 .DS_Store
 .ruby-version
-.rvmrc
+.rvmrc
+*.rdb
+*.store

data/README.md

@@ -47,7 +47,6 @@ p tags
 rss_feed = ButterCMS::Feed.find(:rss)
 puts rss_feed.data
 
-# Try our new custom content feature
 content = ButterCMS::Content.fetch([
   :homepage_html_title,
   :homepage_meta_description,
@@ -55,3 +54,17 @@ content = ButterCMS::Content.fetch([
 ])
 ```
 
+## Fallback Data Store
+
+This client supports automatic fallback to a data store when API requests fail. When a data store is set, on every successful API request the response is written to the data store. When a subsequent API request fails, the client attempts to fallback to the value in the data store. Currently, Redis and YAML Store are supported.
+
+```ruby
+# Use YAMLstore
+ButterCMS::data_store = :yaml, "/File/Path/For/buttercms.store"
+
+# Use Redis
+ButterCMS::data_store = :redis, ENV['REDIS_URL']
+
+# Set logger (optional)
+ButterCMS::logger = MyLogger.new
+```

data/VERSION

@@ -1 +1 @@
-1.0.10
+1.1.0

data/buttercms-ruby.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
 
   s.add_dependency 'rest-client', '>= 1.7.0', '< 2'
+  s.add_dependency 'redis', '>= 3.0.0'
 
   s.add_development_dependency 'rspec', '~> 2.7'
   s.add_development_dependency 'webmock'

data/lib/buttercms-ruby.rb

@@ -1,6 +1,8 @@
 require 'json'
 require 'rest_client'
 require 'ostruct'
+require "redis"
+require 'yaml/store'
 
 require_relative 'buttercms/hash_to_object'
 require_relative 'buttercms/butter_collection'
@@ -12,6 +14,9 @@ require_relative 'buttercms/post'
 require_relative 'buttercms/feed'
 require_relative 'buttercms/content'
 
+require_relative 'buttercms/data_store_adapters/yaml'
+require_relative 'buttercms/data_store_adapters/redis'
+
 # See https://github.com/jruby/jruby/issues/3113
 if RUBY_VERSION < '2.0.0'
   require_relative 'core_ext/ostruct'
@@ -19,33 +24,83 @@ end
 
 module ButterCMS
   @api_url = 'https://api.buttercms.com/v2'
-  @token = nil
 
-  def self.api_token=(token)
-    @token = token
+  class <<self
+    attr_accessor :api_token
+    attr_reader :data_store
+    attr_writer :logger
   end
 
-  def self.token
-    @token
+  def self.logger
+    @logger ||= Logger.new($stdout).tap do |log| 
+      log.progname = "ButterCMS"
+    end
   end
 
-  def self.endpoint
-    @api_url
-  end
+  def self.data_store=(*args)
+    args.flatten!
 
-  def self.request(path, options = {})
-    raise ArgumentError.new "Please set your API token" unless token
+    if args.count < 2
+      raise ArgumentError.new "Wrong number of arguments"
+    end
+    
+    strategy = args.first
+    options = args.drop(1)
+
+    case strategy
+    when :yaml
+      @data_store = ButterCMS::DataStoreAdapters::Yaml.new(options)
+    when :redis
+      @data_store = ButterCMS::DataStoreAdapters::Redis.new(options)
+    else
+      raise ArgumentError.new "Invalid ButterCMS data store #{strategy}"
+    end
+  end
 
+  def self.api_request(path, options = {})
     response = RestClient::Request.execute(
       method: :get,
-      url: endpoint + path,
+      url: @api_url + path,
       headers: {
-        params: options.merge(auth_token: @token)
+        params: options.merge(auth_token: api_token)
       },
       verify_ssl: false
     )
 
-    JSON.parse(response.body)
+    response.body
   end
-end
 
+  def self.request(path, options = {})
+    raise ArgumentError.new "Please set your API token" unless api_token
+
+    key = "buttercms:#{path}:#{options}"
+
+    begin
+      result = api_request(path, options)
+
+      if data_store
+        data_store.set(key, result) 
+        logger.info "Set key #{key}"
+      end
+
+    # TODO - more selective exception handling (RestClient::Exception, SocketError)
+    rescue Exception => e
+
+      if data_store
+        if result = data_store.get(key)
+          logger.info "Fetched key #{key}"
+
+          # Log request error
+          logger.error e
+        else
+          logger.info "No data for key #{key}"
+        end
+      end
+
+      # Raise request exception if there's no data store or value returned
+      raise e unless data_store && result
+    end
+
+    return JSON.parse(result)
+  end
+end

data/lib/buttercms/data_store_adapters/redis.rb

@@ -0,0 +1,19 @@
+module ButterCMS
+  module DataStoreAdapters
+    class Redis
+      def initialize(options)
+        redis_url = options.first
+        
+        @redis = ::Redis.new(url: redis_url)
+      end
+
+      def set(key, value)
+        @redis.set(key, value)
+      end
+
+      def get(key)
+        @redis.get(key)
+      end
+    end
+  end
+end

data/lib/buttercms/data_store_adapters/yaml.rb

@@ -0,0 +1,23 @@
+module ButterCMS
+  module DataStoreAdapters
+    class Yaml
+      def initialize(options)
+        file_path = options.first
+
+        @store = YAML::Store.new file_path
+      end
+
+      def set(key, value)
+        @store.transaction do
+          @store[key] = value
+        end
+      end
+
+      def get(key)
+        @store.transaction do
+          @store[key]
+        end
+      end
+    end
+  end
+end

data/lib/buttercms/version.rb

@@ -1,3 +1,3 @@
 module ButterCMS
-  VERSION = '1.0.10'
+  VERSION = '1.1.0'
 end

data/spec/lib/butter-ruby_spec.rb

@@ -4,11 +4,11 @@ describe ButterCMS do
   describe '.request' do
     context 'with an api token' do
       before do
-        ButterCMS.stub(:token).and_return('test123')
+        ButterCMS.stub(:api_token).and_return('test123')
       end
 
       it 'should make an api request' do
-        stub_request(:get, ButterCMS.endpoint).to_return(body: JSON.generate({data: {test: 'test'}}))
+        stub_request(:get, 'https://api.buttercms.com/v2?auth_token=test123').to_return(body: JSON.generate({data: {test: 'test'}}))
         expect{ ButterCMS.request('') }.to_not raise_error
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buttercms-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.1.0
 platform: ruby
 authors:
 - ButterCMS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,8 @@ files:
 - lib/buttercms/butter_resource.rb
 - lib/buttercms/category.rb
 - lib/buttercms/content.rb
+- lib/buttercms/data_store_adapters/redis.rb
+- lib/buttercms/data_store_adapters/yaml.rb
 - lib/buttercms/errors/buttercms_error.rb
 - lib/buttercms/feed.rb
 - lib/buttercms/hash_to_object.rb