storyblok 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dbb219ff3c07b2f526fa5c816276ae32126dd6b
+  data.tar.gz: f59d2ebfa84847b4b5bb94a580a8e06e0d2e4e4b
+SHA512:
+  metadata.gz: 7e6dd72f70bfa84ec18bf5f130a08a68f6c74d14f4dd39fd22b4bf5219ec183e0f826a48d52ca15bc862580f47b2cef07078607860d5d97b63277fe1cd3ad179
+  data.tar.gz: 4429276f86a4cdf585ff47cfe5a1631a87a0abf800186ef1edc2b4efd9aef91a66bf12453e6c2eb06066eab024f9b7927a2801a78e963beb6ebdab468a396135

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,8 @@
+pkg
+doc/
+.yardoc/
+coverage
+Gemfile.lock
+.idea
+*.DS_Store
+.ruby-version

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,78 @@
+# About
+This is the Storyblok ruby client for easy access of the content delivery api.
+
+## Install
+
+```bash
+gem 'storyblok'
+```
+
+## Usage
+
+### Load a Story
+
+```ruby
+client = new Storyblok(token: 'YOUR_TOKEN')
+
+# Optionally set a cache client
+Storyblok::Cache.client = Redis.new(:url => 'redis://localhost:6379')
+
+# Get a story
+client.story('home')
+```
+
+### Load a list of Stories
+
+```ruby
+# Get all Stories that start with news
+client.stories({
+  :starts_with => 'news'
+})
+```
+
+### Load a list of datasource entries
+
+```ruby
+# Get all label datasource entries
+client.datasource_entries({
+  :datasource => 'labels'
+})
+
+```
+
+### Load a list of tags
+
+```ruby
+# Get all Tags that within the folder news
+client.tags({
+  :starts_with => 'news'
+})
+
+```
+
+## Generate a navigation tree
+
+```ruby
+links = client.links
+tree = links.as_tree
+
+puts '<ul>'
+tree.each do |key, item|
+  puts '<li>' + item['item']['name']
+
+  if !item['children'].empty?
+    puts '<ul>'
+    item['children'].each do |key, inner_item|
+      puts '<li>' + inner_item['item']['name'] + '</li>'
+    end
+    puts '</ul>'
+  end
+
+  puts '</li>'
+end
+puts '</ul>'
+```
+
+### License
+
+This project is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

data/examples/example_queries.rb

@@ -0,0 +1,15 @@
+require 'storyblok'
+
+logger = Logger.new(STDOUT)
+
+client = Storyblok::Client.new(
+  token: 't618GfLe1YHICBioAHnMrwtt',
+  api_url: 'localhost:3001',
+  secure: false,
+  logger: logger
+)
+
+p client.stories(starts_with: 'en/news')
+p client.story('demo1')
+p client.datasource_entries(datasource: 'labels', per_page: 10)
+p client.links

data/examples/tree.rb

@@ -0,0 +1,29 @@
+require 'storyblok'
+
+logger = Logger.new(STDOUT)
+
+client = Storyblok::Client.new(
+  token: 't618GfLe1YHICBioAHnMrwtt',
+  api_url: 'localhost:3001',
+  secure: false,
+  logger: logger
+)
+
+links = client.links
+tree = links.as_tree
+
+puts '<ul>'
+tree.each do |key, item|
+  puts '<li>' + item['item']['name']
+
+  if !item['children'].empty?
+    puts '<ul>'
+    item['children'].each do |key, inner_item|
+      puts '<li>' + inner_item['item']['name'] + '</li>'
+    end
+    puts '</ul>'
+  end
+
+  puts '</li>'
+end
+puts '</ul>'

data/lib/storyblok.rb

@@ -0,0 +1,3 @@
+require 'storyblok/version'
+require 'storyblok/cache'
+require 'storyblok/client'

data/lib/storyblok/cache.rb

@@ -0,0 +1,26 @@
+module Storyblok
+  class Cache
+    def self.client=(client)
+      @client = client
+    end
+
+    def self.client
+      @client
+    end
+
+    def cache(key, expire = nil)
+      if expire == 0
+        return yield(self)
+      end
+
+      if (value = @client.get(key)).nil?
+        value = yield(self)
+        @client.set(key, value)
+        @client.expire(key, expire) if expire
+        value
+      else
+        value
+      end
+    end
+  end
+end

data/lib/storyblok/client.rb

@@ -0,0 +1,153 @@
+require_relative 'request'
+require_relative 'links'
+
+require 'rest-client'
+require 'logger'
+
+module Storyblok
+  class Client
+    DEFAULT_CONFIGURATION = {
+      secure: true,
+      api_url: 'api.storyblok.com',
+      api_version: 1,
+      logger: false,
+      log_level: Logger::INFO,
+      version: 'draft',
+      cache_version: Time.now.to_i
+    }
+
+    attr_reader :configuration, :logger
+
+    # @param [Hash] given_configuration
+    # @option given_configuration [String] :token Required
+    # @option given_configuration [String] :api_url
+    # @option given_configuration [Number] :api_version
+    # @option given_configuration [false, ::Logger] :logger
+    # @option given_configuration [::Logger::DEBUG, ::Logger::INFO, ::Logger::WARN, ::Logger::ERROR] :log_level
+    def initialize(given_configuration = {})
+      @configuration = default_configuration.merge(given_configuration)
+      validate_configuration!
+      setup_logger
+    end
+
+    # Gets a collection of stories
+    #
+    # @param [Hash] query
+    #
+    # @return [Hash]
+    def stories(query = {})
+      Request.new(self, '/cdn/stories', query).get
+    end
+
+    # Gets a specific story
+    #
+    # @param [String] id
+    # @param [Hash] query
+    #
+    # @return [Hash]
+    def story(id, query = {})
+      Request.new(self, '/cdn/stories', query, id).get
+    end
+
+    # Gets a collection of datasource entries
+    #
+    # @param [Hash] query
+    #
+    # @return [Hash]
+    def datasource_entries(query = {})
+      Request.new(self, '/cdn/datasource_entries', query).get
+    end
+
+    # Gets a collection of tags
+    #
+    # @param [Hash] query
+    #
+    # @return [Hash]
+    def tags(query = {})
+      Request.new(self, '/cdn/tags', query).get
+    end
+
+    # Gets a collection of links
+    #
+    # @param [Hash] query
+    #
+    # @return [Hash]
+    def links(query = {})
+      Links.new(Request.new(self, '/cdn/links', query).get)
+    end
+
+    def get(request)
+      endpoint = base_url + request.endpoint
+      query = request_query(request.query)
+      query_string = build_nested_query(query)
+
+      if Cache.client.nil?
+        result = run_request(endpoint, query_string)
+      else
+        cache_key = 'storyblok:' + configuration[:token] + ':' + request.endpoint + ':' + Base64.encode64(query_string)
+        cache_time = 60 * 60 * 2
+
+        result = Cache.client.cache(cache_key, cache_time) do
+          run_request(endpoint, query)
+        end
+      end
+
+      JSON.parse(result)
+    end
+
+    private
+
+    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
+    end
+
+    # Patches a query hash with the client configurations for queries
+    def request_query(query)
+      query[:token] = configuration[:token]
+      query[:version] = configuration[:version] if query[:version].nil?
+      query[:cv] = configuration[:cache_version] if query[:cache_version].nil?
+      query
+    end
+
+    # Returns the base url for all of the client's requests
+    def base_url
+      "http#{configuration[:secure] ? 's' : ''}://#{configuration[:api_url]}/v#{configuration[:api_version]}"
+    end
+
+    def default_configuration
+      DEFAULT_CONFIGURATION.dup
+    end
+
+    def setup_logger
+      @logger = configuration[:logger]
+      logger.level = configuration[:log_level] if logger
+    end
+
+    def validate_configuration!
+      fail ArgumentError, 'You will need to initialize a client with an :token' if configuration[:token].empty?
+      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
+
+    def build_nested_query(value, prefix = nil)
+      case value
+      when Array
+        value.map { |v|
+          build_nested_query(v, "#{prefix}[]")
+        }.join("&")
+      when Hash
+        value.map { |k, v|
+          build_nested_query(v, prefix ? "#{prefix}[#{URI.encode_www_form_component(k)}]" : URI.encode_www_form_component(k))
+        }.reject(&:empty?).join('&')
+      when nil
+        prefix
+      else
+        raise ArgumentError, "value must be a Hash" if prefix.nil?
+        "#{prefix}=#{URI.encode_www_form_component(value)}"
+      end
+    end
+  end
+end

data/lib/storyblok/links.rb

@@ -0,0 +1,42 @@
+module Storyblok
+  class Links
+    def initialize(response_obj)
+      @links = response_obj['data']['links']
+    end
+
+    def as_tree
+      tree = {}
+
+      @links.each do |key, item|
+        if tree[item['parent_id']].nil?
+          tree[item['parent_id']] = []
+        end
+
+        tree[item['parent_id']] << item
+      end
+
+      generate_tree(0, tree)
+    end
+
+    private
+
+    def generate_tree(parent_id = 0, items)
+      tree = {}
+
+      if !items[parent_id].nil?
+        result = items[parent_id]
+
+        result.each do |item|
+          if tree[item['id']].nil?
+            tree[item['id']] = {}
+          end
+
+          tree[item['id']]['item'] = item
+          tree[item['id']]['children'] = generate_tree(item['id'], items)
+        end
+      end
+
+      tree
+    end
+  end
+end

data/lib/storyblok/request.rb

@@ -0,0 +1,37 @@
+module Storyblok
+  # This object represents a request that is to be made. It gets initialized by the client
+  # with domain specific logic. The client later uses the Request's #url and #query methods
+  # to execute the HTTP request.
+  class Request
+    attr_reader :client, :type, :query, :id, :endpoint
+
+    def initialize(client, endpoint, query = {}, id = nil)
+      @client = client
+      @endpoint = endpoint
+      @query = query
+
+      if id
+        @type = :single
+        @id = URI.escape(id)
+      else
+        @type = :multi
+        @id = nil
+      end
+    end
+
+    # Returns the final URL, relative to a storyblok space
+    def url
+      "#{@endpoint}#{@type == :single ? "/#{id}" : ''}"
+    end
+
+    # Delegates the actual HTTP work to the client
+    def get
+      client.get(self)
+    end
+
+    # Returns a new Request object with the same data
+    def copy
+      Marshal.load(Marshal.dump(self))
+    end
+  end
+end

data/lib/storyblok/version.rb

@@ -0,0 +1,4 @@
+module Storyblok
+  # Gem Version
+  VERSION = '1.0.0'
+end

data/storyblok.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/storyblok/version', __FILE__)
+
+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.license       = 'MIT'
+  gem.authors       = ['Storyblok (Alexander Feiglstorfer)']
+  gem.email         = 'it@storyblok.com'
+  gem.homepage      = 'https://github.com/storyblok/storyblok-ruby'
+
+  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) && !path.start_with?('pkg') }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'rest-client', '~> 1.8'
+
+  gem.add_development_dependency 'bundler', '~> 1.5'
+  gem.add_development_dependency 'rspec', '~> 3'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: storyblok
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Storyblok (Alexander Feiglstorfer)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Ruby client for the https://www.storyblok.com Content Delivery API
+email: it@storyblok.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- examples/example_queries.rb
+- examples/tree.rb
+- lib/storyblok.rb
+- lib/storyblok/cache.rb
+- lib/storyblok/client.rb
+- lib/storyblok/links.rb
+- lib/storyblok/request.rb
+- lib/storyblok/version.rb
+- storyblok.gemspec
+homepage: https://github.com/storyblok/storyblok-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: storyblok
+test_files: []