storyblok 2.1.1 → 3.0.0

data/spec/lib/storyblok_request_spec.rb

@@ -0,0 +1,23 @@
+require_relative '../../lib/storyblok/request'
+require 'spec_helper'
+
+describe Storyblok::Request do
+  subject { described_class.new(client, endpoint) }
+
+  let(:client) { 'fake_client' }
+  let(:endpoint) { 'some.url.com' }
+  let(:query) { {my_key: 'my_value'} }
+  let(:id) { 222 }
+
+  context "#copy" do
+    it "Returns a copy of StoryBlock:Request object initialized" do
+      object_duplicated = subject.copy
+      expect(subject.client).to        eq(object_duplicated.client)
+      expect(subject.endpoint).to      eq(object_duplicated.endpoint)
+      expect(subject.query).to         eq(object_duplicated.query)
+      expect(subject.id).to            eq(object_duplicated.id)
+      expect(subject.type).to          eq(object_duplicated.type)
+      expect(subject.object_id).not_to eq(object_duplicated.object_id)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+require 'vcr'
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  config.configure_rspec_metadata!
+  config.hook_into :webmock
+  config.default_cassette_options = {
+    :match_requests_on => [:method, VCR.request_matchers.uri_without_params(:cv, :cache_version)]
+  }
+  config.allow_http_connections_when_no_cassette = true
+end
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+  begin
+    # This allows you to limit a spec run to individual examples or groups
+    # you care about by tagging them with `:focus` metadata. When nothing
+    # is tagged with `:focus`, all examples get run. RSpec also provides
+    # aliases for `it`, `describe`, and `context` that include `:focus`
+    # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+    config.filter_run_when_matching :focus
+
+    # Allows RSpec to persist some state between runs in order to support
+    # the `--only-failures` and `--next-failure` CLI options. We recommend
+    # you configure your source control system to ignore this file.
+    # config.example_status_persistence_file_path = "spec/examples.txt"
+
+    # Limits the available syntax to the non-monkey patched syntax that is
+    # recommended. For more details, see:
+    #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+    #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+    # config.disable_monkey_patching!
+
+    # This setting enables warnings. It's recommended, but in some cases may
+    # be too noisy due to issues in dependencies.
+    # config.warnings = true
+
+    # Many RSpec users commonly either run the entire suite or an individual
+    # file, and it's useful to allow more verbose output when running an
+    # individual spec file.
+    if config.files_to_run.one?
+      # Use the documentation formatter for detailed output,
+      # unless a formatter has already been configured
+      # (e.g. via a command-line flag).
+      config.default_formatter = "doc"
+    end
+
+    # Print the 10 slowest examples and example groups at the
+    # end of the spec run, to help surface which specs are running
+    # particularly slow.
+    # config.profile_examples = 10
+
+    # Run specs in random order to surface order dependencies. If you find an
+    # order dependency and want to debug it, you can fix the order by providing
+    # the seed, which is printed after each run.
+    #     --seed 1234
+    # config.order = :random
+
+    # Seed global randomization in this process using the `--seed` CLI option.
+    # Setting this allows you to use `--seed` to deterministically reproduce
+    # test failures related to randomization by passing the same `--seed` value
+    # as the one that triggered the failure.
+    # Kernel.srand config.seed
+  end
+end

data/spec/v2/storyblok_client_spec.rb

@@ -0,0 +1,292 @@
+require_relative '../../lib/storyblok/client'
+require_relative '../../lib/storyblok/cache/redis'
+require 'redis'
+require 'spec_helper'
+
+describe Storyblok::Client do
+  subject { described_class.new(token: token, version: version) }
+  let(:subject_v1) { described_class.new(api_version: 1, token: token, version: version) }
+
+  context "V2" do
+    context "When querying CDN Content" do
+
+      context "With token defined" do
+        let(:token) { '<SPACE_PUBLIC_TOKEN>' }
+
+        context "When querying stories" do
+
+          context "When querying the published version" do
+            let(:version) { 'published' }
+
+            context "when querying an existent story by slug" do
+              it "returns a story", :vcr do
+                expect(subject.story('simple_content')['data']).to eq({
+                  "story"=> {
+                    "name"=> "simple_content",
+                    "created_at"=> "2020-08-20T18:01:55.065Z",
+                    "published_at"=> "2021-11-11T20:16:01.847Z",
+                    "id"=> 18409805,
+                    "uuid"=> "fe520269-b092-482c-94c4-8028eb81af41",
+                    "content"=> {
+                      "_uid"=> "ae111a76-84b7-43cc-a6a0-77a70de1b6f4",
+                      "component"=> "SimpleTextContentType",
+                      "SimpleText"=> "Simple Content from a Simple Text PUBLISHED VERSION"
+                    },
+                    "slug"=> "simple_content",
+                    "full_slug"=> "simple_content",
+                    "sort_by_date"=> nil,
+                    "position"=> 0,
+                    "tag_list"=> [
+                      "tag_out_of_any_folder"
+                    ],
+                    "is_startpage"=> false,
+                    "parent_id"=> 0,
+                    "meta_data"=> nil,
+                    "group_id"=> "f905f0f0-569e-4036-bcef-1479e5088956",
+                    "first_published_at"=> "2020-08-20T18:03:33.000Z",
+                    "release_id"=> nil,
+                    "lang"=> "default",
+                    "path"=> nil,
+                    "alternates"=> [],
+                    "default_full_slug"=> nil,
+                    "translated_slugs"=> nil
+                  },
+                  "cv"=> 1637246408,
+                  "rels"=> [],
+                  "links"=> []
+                })
+              end
+
+              context "using resolve_relations", :vcr do
+                it "returns a story with relations resolved", :vcr do
+                  expect(subject.story('content-resolve-relations', resolve_relations: 'options-list.options')['data']).to eq(
+                    {
+                      "story"=>{
+                        "name"=>"content resolve relations",
+                        "created_at"=>"2021-11-16T19:45:13.233Z",
+                        "published_at"=>"2021-11-18T14:40:08.858Z",
+                        "id"=>85924760,
+                        "uuid"=>"8926c2a6-e0ac-4afd-9132-0f7016699c16",
+                        "content"=>{
+                          "_uid"=>"7e385817-6fcb-4860-b510-f9b2bc56c7e6",
+                          "body"=>[
+                            {
+                              "_uid"=>"eaf49c11-e254-4609-af43-6840e1d52115",
+                              "options"=>[
+                                {
+                                  "name"=>"simple_content_1",
+                                  "created_at"=>"2020-08-20T18:45:52.758Z",
+                                  "published_at"=>"2021-11-16T20:46:31.256Z",
+                                  "id"=>18409845,
+                                  "uuid"=>"542e19cc-ff06-4f19-ae64-a725c89e3406",
+                                  "content"=>{
+                                    "_uid"=>"e8ac85a4-91eb-42c2-8a18-b6e709b67e9d",
+                                    "component"=>"SimpleTextContentType",
+                                    "SimpleText"=>"Simple Content Draft"
+                                  },
+                                  "slug"=>"simple_content_1",
+                                  "full_slug"=>"my-folder-slug/simple_content_1",
+                                  "sort_by_date"=> nil,
+                                  "position"=>0,
+                                  "tag_list"=>[],
+                                  "is_startpage"=>false,
+                                  "parent_id"=>18409844,
+                                  "meta_data"=> nil,
+                                  "group_id"=>"943ee7f6-b002-44c6-8e26-41b21b6792ea",
+                                  "first_published_at"=>"2020-08-20T18:46:39.840Z",
+                                  "release_id"=> nil,
+                                  "lang"=>"default",
+                                  "path"=> nil,
+                                  "alternates"=>[],
+                                  "default_full_slug"=> nil,
+                                  "translated_slugs"=> nil
+                                }
+                              ],
+                              "component"=>"options-list"
+                            }
+                          ],
+                          "component"=>"page"
+                        },
+                        "slug"=>"content-resolve-relations",
+                        "full_slug"=>"content-resolve-relations",
+                        "sort_by_date"=> nil,
+                        "position"=>-100,
+                        "tag_list"=>[],
+                        "is_startpage"=>false,
+                        "parent_id"=>0,
+                        "meta_data"=> nil,
+                        "group_id"=>"5f656b63-f64a-4648-aed8-b9ac2ea069e5",
+                        "first_published_at"=>"2021-11-16T20:28:35.000Z",
+                        "release_id"=> nil,
+                        "lang"=>"default",
+                        "path"=> nil,
+                        "alternates"=>[],
+                        "default_full_slug"=> nil,
+                        "translated_slugs"=> nil
+                      },
+                      "cv"=>1637246408,
+                      "rels"=>[
+                        {
+                          "name"=>"simple_content_1",
+                          "created_at"=>"2020-08-20T18:45:52.758Z",
+                          "published_at"=>"2021-11-16T20:46:31.256Z",
+                          "id"=>18409845,
+                          "uuid"=>"542e19cc-ff06-4f19-ae64-a725c89e3406",
+                          "content"=>{
+                            "_uid"=>"e8ac85a4-91eb-42c2-8a18-b6e709b67e9d",
+                            "component"=>"SimpleTextContentType",
+                            "SimpleText"=>"Simple Content Draft"
+                          },
+                          "slug"=>"simple_content_1",
+                          "full_slug"=>"my-folder-slug/simple_content_1",
+                          "sort_by_date"=> nil,
+                          "position"=>0,
+                          "tag_list"=>[],
+                          "is_startpage"=>false,
+                          "parent_id"=>18409844,
+                          "meta_data"=> nil,
+                          "group_id"=>"943ee7f6-b002-44c6-8e26-41b21b6792ea",
+                          "first_published_at"=>"2020-08-20T18:46:39.840Z",
+                          "release_id"=> nil,
+                          "lang"=>"default",
+                          "path"=> nil,
+                          "alternates"=>[],
+                          "default_full_slug"=> nil,
+                          "translated_slugs"=> nil
+                        }
+                      ],
+                      "links"=>[]
+                    }
+                  )
+                end
+              end
+
+              context "using resolve_links", :vcr do
+                it "returns a story with links resolved" do
+                  expect(subject.story('content-resolve-links', resolve_links: 1)['data']).to eq({
+                    "story"=> {
+                      "name"=> "content resolve links",
+                      "created_at"=> "2021-11-18T17:43:08.695Z",
+                      "published_at"=> "2021-11-18T19:23:22.657Z",
+                      "id"=> 86436757,
+                      "uuid"=> "e93f2707-775c-41d4-8ad5-413975318d93",
+                      "content"=> {
+                        "_uid"=> "d8e13705-ddf8-4f4f-8432-d3baece5ec23",
+                        "body"=> [],
+                        "component"=> "page",
+                        "link_to_story"=> {
+                          "id"=> "fe520269-b092-482c-94c4-8028eb81af41",
+                          "url"=> "",
+                          "anchor"=> "",
+                          "linktype"=> "story",
+                          "fieldtype"=> "multilink",
+                          "cached_url"=> "simple_content",
+                          "story"=> {
+                            "name"=> "simple_content",
+                            "created_at"=> "2020-08-20T18:01:55.065Z",
+                            "published_at"=> "2021-11-11T20:16:01.847Z",
+                            "id"=> 18409805,
+                            "uuid"=> "fe520269-b092-482c-94c4-8028eb81af41",
+                            "content"=> {
+                              "_uid"=> "ae111a76-84b7-43cc-a6a0-77a70de1b6f4",
+                              "component"=> "SimpleTextContentType",
+                              "SimpleText"=> "Simple Content from a Simple Text PUBLISHED VERSION"
+                            },
+                            "slug"=> "simple_content",
+                            "full_slug"=> "simple_content",
+                            "sort_by_date"=> nil,
+                            "position"=> 0,
+                            "tag_list"=> [
+                              "tag_out_of_any_folder"
+                            ],
+                            "is_startpage"=> false,
+                            "parent_id"=> 0,
+                            "meta_data"=> nil,
+                            "group_id"=> "f905f0f0-569e-4036-bcef-1479e5088956",
+                            "first_published_at"=> "2020-08-20T18:03:33.000Z",
+                            "release_id"=> nil,
+                            "lang"=> "default",
+                            "path"=> nil,
+                            "alternates"=> [],
+                            "default_full_slug"=> nil,
+                            "translated_slugs"=> nil
+                          }
+                        },
+                        "link_to_story_2"=> {
+                          "id"=> "",
+                          "url"=> "",
+                          "linktype"=> "url",
+                          "fieldtype"=> "multilink",
+                          "cached_url"=> ""
+                        }
+                      },
+                      "slug"=> "content-resolve-links",
+                      "full_slug"=> "content-resolve-links",
+                      "sort_by_date"=> nil,
+                      "position"=> -110,
+                      "tag_list"=> [],
+                      "is_startpage"=> false,
+                      "parent_id"=> 0,
+                      "meta_data"=> nil,
+                      "group_id"=> "7f03b8db-6237-48b4-abd7-6bc8a0f459c8",
+                      "first_published_at"=> "2021-11-18T17:51:19.000Z",
+                      "release_id"=> nil,
+                      "lang"=> "default",
+                      "path"=> nil,
+                      "alternates"=> [],
+                      "default_full_slug"=> nil,
+                      "translated_slugs"=> nil
+                    },
+                    "cv"=> 1637263402,
+                    "rels"=> [],
+                    "links"=> [
+                      {
+                        "name"=> "simple_content",
+                        "created_at"=> "2020-08-20T18:01:55.065Z",
+                        "published_at"=> "2021-11-11T20:16:01.847Z",
+                        "id"=> 18409805,
+                        "uuid"=> "fe520269-b092-482c-94c4-8028eb81af41",
+                        "content"=> {
+                          "_uid"=> "ae111a76-84b7-43cc-a6a0-77a70de1b6f4",
+                          "component"=> "SimpleTextContentType",
+                          "SimpleText"=> "Simple Content from a Simple Text PUBLISHED VERSION"
+                        },
+                        "slug"=> "simple_content",
+                        "full_slug"=> "simple_content",
+                        "sort_by_date"=> nil,
+                        "position"=> 0,
+                        "tag_list"=> [
+                          "tag_out_of_any_folder"
+                        ],
+                        "is_startpage"=> false,
+                        "parent_id"=> 0,
+                        "meta_data"=> nil,
+                        "group_id"=> "f905f0f0-569e-4036-bcef-1479e5088956",
+                        "first_published_at"=> "2020-08-20T18:03:33.000Z",
+                        "release_id"=> nil,
+                        "lang"=> "default",
+                        "path"=> nil,
+                        "alternates"=> [],
+                        "default_full_slug"=> nil,
+                        "translated_slugs"=> nil
+                      }
+                    ]
+                  })
+                end
+              end
+
+              context "comparing v2 and v1 to assure backward compatibility", :vcr do
+                it "returns difference in translated_slug default value" do
+                  v2_content = subject.story("content-resolve-relations", resolve_relations: "options-list.options", cv: 1)["data"]["story"]
+                  v1_content = subject_v1.story("content-resolve-relations", resolve_relations: "options-list.options", cv: 1)["data"]["story"]
+
+                  expect(Hashdiff.diff(v2_content, v1_content)).to eq [["~", "content.body[0].options[0].translated_slugs", nil, []], ["~", "translated_slugs", nil, []]]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/storyblok.gemspec

@@ -19,5 +19,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'storyblok-richtext-renderer', '>= 0.0.4', '< 1'
 
   gem.add_development_dependency 'bundler', '~> 1.5'
+  gem.add_development_dependency 'hashdiff', '~> 1.0', '>= 1.0.1'
   gem.add_development_dependency 'rspec', '~> 3'
+  gem.add_development_dependency 'webmock', '~> 0'
+  gem.add_development_dependency 'vcr', '~> 0'
+  gem.add_development_dependency 'simplecov', '< 0.18.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storyblok
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Storyblok (Alexander Feiglstorfer)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -64,6 +64,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +98,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 description: Ruby client for the https://www.storyblok.com management and content
   delivery API
 email: it@storyblok.com
@@ -88,6 +150,7 @@ files:
 - ".DS_Store"
 - ".editorconfig"
 - ".gitignore"
+- ".rspec"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
@@ -105,6 +168,11 @@ files:
 - lib/storyblok/links.rb
 - lib/storyblok/request.rb
 - lib/storyblok/version.rb
+- spec/lib/storyblok_cache_redis_spec.rb
+- spec/lib/storyblok_client_spec.rb
+- spec/lib/storyblok_request_spec.rb
+- spec/spec_helper.rb
+- spec/v2/storyblok_client_spec.rb
 - storyblok.gemspec
 homepage: https://github.com/storyblok/storyblok-ruby
 licenses:
@@ -130,4 +198,9 @@ rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: storyblok
-test_files: []
+test_files:
+- spec/lib/storyblok_cache_redis_spec.rb
+- spec/lib/storyblok_client_spec.rb
+- spec/lib/storyblok_request_spec.rb
+- spec/spec_helper.rb
+- spec/v2/storyblok_client_spec.rb