storyblok 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9876a3898f429335e6252d7d52962dbf2ff6af96
-  data.tar.gz: 1795aeb2880895aa2f05d244513af07ad41f16bf
+SHA256:
+  metadata.gz: ba3b3cbf9eb1bf234d0d093ad0d8e608b60408a1c62d650ab26d292114a45588
+  data.tar.gz: fd55258a2032f6aa3befad526afb5bd3191f6eb9a2c8bbe5220098f484224a12
 SHA512:
-  metadata.gz: 2191647a2248d3e851dbc9157a521b2223a9ba5d40123e4682f5d90b7b93c9e1a7057b81ebf8d28afc16534f6faa10f1221005fb7db6b818817d919f577d70b4
-  data.tar.gz: e4a111074b5ae3019c1ff9df0a7de5f97cc2ec3d27ea105b1a7cef9a4fce8bc3b36518439511035e79e9f38904f13738bfcd7639542728e4da5618459fb82c29
+  metadata.gz: 489b55d03fa510f6aecbd1da080e173f707e34bc45168a0d14644efc77ba798090e5667a820b85999a65f97c94f46828c43f9dcb9cc1984ed0054aaf573555f5
+  data.tar.gz: d96a28a42e2e0cf7517fbfa44d37db9138c1e9939aa37539d04932dd562545ebdf5e00bdbb3d1c964a0517e57bcfe21dfd173b6be22799ef19b9be8ac52e99f2

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    storyblok (2.0.1)
+      rest-client (>= 1.8.0, < 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    netrc (0.11.0)
+    redis (4.1.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  redis
+  rspec (~> 3)
+  storyblok!
+
+BUNDLED WITH
+   1.16.6

data/README.md

@@ -1,5 +1,5 @@
 # About
-This is the Storyblok ruby client for easy access of the content delivery api.
+This is the Storyblok ruby client for easy access of the management and content delivery api.
 
 ## Install
 
@@ -7,15 +7,28 @@ This is the Storyblok ruby client for easy access of the content delivery api.
 gem 'storyblok'
 ```
 
-## Usage
+## Usage for the content delivery api
+
+By default the client loads the "draft" version of the Story. Be sure to set the version to "published" to get the published content only.
+
+```ruby
+# The draft mode is required for the preview
+Storyblok::Client.new(version: 'draft')
+
+# Requests only published stories
+Storyblok::Client.new(version: 'published')
+```
 
 ### Load a Story
 
 ```ruby
+# Without cache
 client = Storyblok::Client.new(token: 'YOUR_TOKEN')
 
 # Optionally set a cache client
-Storyblok::Cache.client = Redis.new(:url => 'redis://localhost:6379')
+redis = Redis.new(url: 'redis://localhost:6379')
+cache = Storyblok::Cache::Redis.new(redis: Redis.current)
+client = Storyblok::Client.new(cache: cache, token: 'YOUR_TOKEN')
 
 # Get a story
 client.story('home')
@@ -72,6 +85,51 @@ end
 puts '</ul>'
 ```
 
+## How to flush the cache
+
+Following an example of how to flush the client cache:
+
+```ruby
+cache = Storyblok::Cache::Redis.new(redis: Redis.current)
+client = Storyblok::Client.new(cache: cache, token: 'YOUR_TOKEN')
+
+# Get a story and cache it
+client.story('home')
+
+# Flush the cache
+client.flush
+```
+
+## Usage for the management api
+
+### Initialize the client and load spaces
+
+```ruby
+client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')
+
+# Get your spaces
+client.get('spaces')
+```
+
+### Create a story
+
+```ruby
+client.post("spaces/{space_id}/stories", {story: {name: 'new', slug: "new"}})
+```
+
+### Update a story
+
+```ruby
+client.put("spaces/{space_id}/stories/{story_id}", {story: {name: 'new', slug: "new"}})
+```
+
+### Delete a story
+
+```ruby
+client.delete("spaces/{space_id}/stories/{story_id}")
+```
+
+
 ### License
 
 This project is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

data/examples/management_api.rb

@@ -0,0 +1,33 @@
+# bundle exec ruby examples/management_api.rb
+
+require 'storyblok'
+
+logger = Logger.new(STDOUT)
+
+client = Storyblok::Client.new(
+  token: 'A5uTnm0GXLBLhwaGrhHdQwtt',
+  oauth_token: 'OAUTH_TOKEN',
+  logger: logger
+)
+
+spaces = client.get('spaces')['data']['spaces']
+space = spaces.first
+
+p client.get("spaces/#{space['id']}")['data']['space']
+story_res = client.post("spaces/#{space['id']}/stories", {story: {name: 'new', slug: "new"}})['data']
+
+10.times do |index|
+  client.get("spaces/#{space['id']}/stories/#{story_res['story']['id']}")
+  puts index
+end
+
+p client.put("spaces/#{space['id']}/stories/#{story_res['story']['id']}", {story: {name: 'new123'}})['data']
+
+10.times do |index|
+  client.story('new')
+  puts index
+end
+
+p client.delete("spaces/#{space['id']}/stories/#{story_res['story']['id']}")
+
+

data/lib/storyblok/client.rb

@@ -22,7 +22,8 @@ module Storyblok
     attr_reader :configuration, :logger
 
     # @param [Hash] given_configuration
-    # @option given_configuration [String] :token Required
+    # @option given_configuration [String] :token Required if oauth_token is not set
+    # @option given_configuration [String] :oauth_token Required if token is not set
     # @option given_configuration [String] :api_url
     # @option given_configuration [Number] :api_version
     # @option given_configuration [false, ::Logger] :logger
@@ -30,6 +31,13 @@ module Storyblok
     def initialize(given_configuration = {})
       @configuration = default_configuration.merge(given_configuration)
       validate_configuration!
+
+      if configuration[:oauth_token]
+        @rest_client = RestClient::Resource.new(base_url, :headers => {
+          :authorization => configuration[:oauth_token]
+        })
+      end
+
       setup_logger
     end
 
@@ -88,7 +96,47 @@ module Storyblok
       Links.new(Request.new(self, '/cdn/links', query).get).as_tree
     end
 
-    def get(request)
+    def post(path, payload, additional_headers = {})
+      run_management_request(:post, path, payload, additional_headers)
+    end
+
+    def put(path, payload, additional_headers = {})
+      run_management_request(:put, path, payload, additional_headers)
+    end
+
+    def delete(path, additional_headers = {})
+      run_management_request(:delete, path, nil, additional_headers)
+    end
+
+    def get(path, additional_headers = {})
+      run_management_request(:get, path, nil, additional_headers)
+    end
+
+    def run_management_request(action, path, payload = {}, additional_headers = {})
+      logger.info(request: { path: path, action: action }) if logger
+      retries_left = 3
+
+      begin
+        if [:post, :put].include?(action)
+          res = @rest_client[path].send(action, payload, additional_headers)
+        else
+          res = @rest_client[path].send(action, additional_headers)
+        end
+      rescue RestClient::TooManyRequests
+        if retries_left != 0
+          retries_left -= 1
+          logger.info("Too many requests. Retry nr. #{(3 - retries_left).to_s} of max. 3 times.") if logger
+          sleep(0.5)
+          retry
+        end
+
+        raise
+      end
+
+      parse_result(res)
+    end
+
+    def cached_get(request)
       endpoint = base_url + request.url
       query = request_query(request.query)
       query_string = build_nested_query(query)
@@ -115,11 +163,29 @@ module Storyblok
 
     private
 
+    def parse_result(res)
+      {'headers' => res.headers, 'data' => JSON.parse(res.body)}
+    end
+
     def run_request(endpoint, query_string)
       logger.info(request: { endpoint: endpoint, query: query_string }) if logger
-      res = RestClient.get "#{endpoint}?#{query_string}"
 
-      {headers: res.headers, data: JSON.parse(res.body)}.to_json
+      retries_left = 3
+
+      begin
+        res = RestClient.get "#{endpoint}?#{query_string}"
+      rescue RestClient::TooManyRequests
+        if retries_left != 0
+          retries_left -= 1
+          logger.info("Too many requests. Retry nr. #{(3 - retries_left).to_s} of max. 3 times.") if logger
+          sleep(0.5)
+          retry
+        end
+
+        raise
+      end
+
+      {'headers' => res.headers, 'data' => JSON.parse(res.body)}.to_json
     end
 
     # Patches a query hash with the client configurations for queries
@@ -149,7 +215,7 @@ module Storyblok
     end
 
     def validate_configuration!
-      fail ArgumentError, 'You will need to initialize a client with an :token' if configuration[:token].empty?
+      fail ArgumentError, 'You will need to initialize a client with an :token or :oauth_token' if !configuration[:token] and !configuration[:oauth_token]
       fail ArgumentError, 'The client configuration needs to contain an :api_url' if configuration[:api_url].empty?
       fail ArgumentError, 'The :api_version must be a positive number' unless configuration[:api_version].to_i >= 0
     end

data/lib/storyblok/request.rb

@@ -26,7 +26,7 @@ module Storyblok
 
     # Delegates the actual HTTP work to the client
     def get
-      client.get(self)
+      client.cached_get(self)
     end
 
     # Returns a new Request object with the same data

data/lib/storyblok/version.rb

@@ -1,4 +1,4 @@
 module Storyblok
   # Gem Version
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/storyblok.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |gem|
   gem.name          = 'storyblok'
   gem.version       = Storyblok::VERSION
   gem.summary       = 'storyblok'
-  gem.description   = 'Ruby client for the https://www.storyblok.com Content Delivery API'
+  gem.description   = 'Ruby client for the https://www.storyblok.com management and content delivery API'
   gem.license       = 'MIT'
   gem.authors       = ['Storyblok (Alexander Feiglstorfer)']
   gem.email         = 'it@storyblok.com'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storyblok
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Storyblok (Alexander Feiglstorfer)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -58,7 +58,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-description: Ruby client for the https://www.storyblok.com Content Delivery API
+description: Ruby client for the https://www.storyblok.com management and content
+  delivery API
 email: it@storyblok.com
 executables: []
 extensions: []
@@ -66,10 +67,13 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
+- Gemfile.lock
 - README.md
 - examples/cache.rb
 - examples/example_queries.rb
+- examples/management_api.rb
 - examples/tree.rb
 - lib/storyblok.rb
 - lib/storyblok/cache/redis.rb
@@ -77,7 +81,6 @@ files:
 - lib/storyblok/links.rb
 - lib/storyblok/request.rb
 - lib/storyblok/version.rb
-- storyblok-1.0.4.gem
 - storyblok.gemspec
 homepage: https://github.com/storyblok/storyblok-ruby
 licenses:
@@ -99,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: storyblok