locomotivecms_coal 1.5.1 → 1.6.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 175b0d7b475cd00f783328880c9329625b1e5e2b832971c1df42becbf2374ec8
-  data.tar.gz: 7905604dc94110af0a2dd4226402181d3f3ed2e628348f200b14d0e7b35ab993
+  metadata.gz: 52e508034f1bf2fb7543cac7cdd993d970f50e404711eb931c473e08ba39cbff
+  data.tar.gz: a6fc26f79e02e09e22cefa711f61ac6031dd95d07ef0684767fbfd50cfa4dc37
 SHA512:
-  metadata.gz: 6ebb8690d146ab6c23be41a2268115fbaadb0c767b9465b167069bebae94c534260007a14fbb8ef28d8578d8317e67727924e89b0113fd86f418688084acbbcf
-  data.tar.gz: '082bc3a750bf08208b647b5cee0ae83105fc0a326984910192c90967eafeb580ba1c22dabc86412fb4f45d1e84afd487c9ef23a72bbc1bd2c33906762787d8f9'
+  metadata.gz: 45ef04a703b534d2cff43327262deb5600ec58f894523100f038eda5ad8ce525b53450551c1efae99d8f0e4cc557fd08d33e8789e90b1fa937d1235fde40c5c5
+  data.tar.gz: 9103f51b7bd5621e46478bf4009e4a5d34264c754a288170c3c216f8ac59a8c389d05d4285bfcf9cacc1311aa2089c9292fb538f1e289cba2f39328553c08af2

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    locomotivecms_coal (1.5.1)
-      activesupport (~> 5.1.5)
-      faraday (~> 0.14.0)
+    locomotivecms_coal (1.6.0.beta1)
+      activesupport (>= 5.1.5, < 6.0)
+      faraday (~> 0.15.4)
       faraday_middleware (~> 0.12.2)
       httpclient (~> 2.8.3)
       mime-types (~> 3.1.0)
@@ -11,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.6)
+    activesupport (5.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -22,7 +22,7 @@ GEM
     codeclimate-test-reporter (1.0.7)
       simplecov
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.4)
     coveralls (0.8.21)
       json (>= 1.8, < 3)
       simplecov (~> 0.14.1)
@@ -35,7 +35,7 @@ GEM
     docile (1.1.5)
     domain_name (0.5.20170404)
       unf (>= 0.0.5, < 1.0.0)
-    faraday (0.14.0)
+    faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
@@ -43,7 +43,7 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     httpclient (2.8.3)
-    i18n (1.0.1)
+    i18n (1.2.0)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
     json_spec (1.1.5)

data/README.md

@@ -16,6 +16,7 @@ The Ruby API Client for LocomotiveCMS V3.
       - [Content Types](#content-types)
       - [Content Entries](#content-entries)
       - [Snippets](#snippets)
+      - [Sections](#sections)
       - [Theme Assets](#theme-assets)
       - [Content Assets](#content-assets)
       - [Translations](#translations)
@@ -198,6 +199,24 @@ To get the snippets in the FR locale:
 
     site_client.snippets.destroy('header')
 
+#### Sections
+
+**Get the list of sections**
+
+    sections = site_client.sections.all
+
+**Create a section**
+
+    snippet = site_client.sections.create(name: 'Header', slug: 'header', template: 'Locomotive rocks!', settings: [{ id: 'title', type: 'string' }])
+
+**Update a section**
+
+    site_client.sections.update('header', template: 'Locomotive rocks!!!')
+
+**Destroy a section**
+
+    site_client.sections.destroy('header')
+
 #### Theme assets
 
 **Get the list of theme assets**

data/Rakefile

@@ -5,9 +5,6 @@ require 'bundler/gem_tasks'
 require 'rake'
 require 'rspec'
 
-# === Gems install tasks ===
-Bundler::GemHelper.install_tasks
-
 require_relative 'lib/locomotive/coal'
 
 require 'rspec/core/rake_task'

data/lib/locomotive/coal/client.rb

@@ -56,6 +56,10 @@ module Locomotive::Coal
       @snippets ||= Resources::Snippets.new(uri, connection)
     end
 
+    def sections
+      @sections ||= Resources::Sections.new(uri, connection)
+    end
+
     def translations
       @translations ||= Resources::Translations.new(uri, connection)
     end

data/lib/locomotive/coal/error.rb

@@ -69,7 +69,7 @@ module Locomotive::Coal
             "#{name}.#{k}: #{_errors.join(' + ')}"
           end
         else
-          "#{name} #{errors.join(' ')}"
+          "#{name} #{errors.join(', ')}"
         end
       end.join(', ')
 

data/lib/locomotive/coal/resources/sections.rb

@@ -0,0 +1,17 @@
+module Locomotive::Coal
+  module Resources
+
+    class Sections < Base
+
+      def index
+        get(resources_name).map do |attributes|
+          Resource.new(attributes)
+        end
+      end
+
+      alias :all :index
+
+    end
+
+  end
+end

data/lib/locomotive/coal/version.rb

@@ -3,6 +3,6 @@
 # 1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-alpha.beta < 1.0.0-beta < 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0
 module Locomotive
   module Coal
-    VERSION = '1.5.1'
+    VERSION = '1.6.0.beta1'
   end
 end

data/lib/locomotive/coal.rb

@@ -22,6 +22,7 @@ require_relative 'coal/resources/sites'
 require_relative 'coal/resources/current_site'
 require_relative 'coal/resources/pages'
 require_relative 'coal/resources/snippets'
+require_relative 'coal/resources/sections'
 require_relative 'coal/resources/content_assets'
 require_relative 'coal/resources/theme_assets'
 require_relative 'coal/resources/translations'

data/locomotivecms_coal.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake',       '~> 12.3.0'
 
   spec.add_dependency 'httpclient',             '~> 2.8.3'
-  spec.add_dependency 'faraday',                '~> 0.14.0'
+  spec.add_dependency 'faraday',                '~> 0.15.4'
   spec.add_dependency 'faraday_middleware',     '~> 0.12.2'
-  spec.add_dependency 'activesupport',          '~> 5.1.5'
+  spec.add_dependency 'activesupport',          '>= 5.1.5', '< 6.0'
   spec.add_dependency 'mime-types',             '~> 3.1.0'
 
   spec.required_ruby_version = '>= 2.0'

data/spec/fixtures/coal_cassettes/sections.yml

@@ -0,0 +1,224 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3000/locomotive/api/v3/tokens.json
+    body:
+      encoding: UTF-8
+      string: email=admin%40locomotivecms.com&password=locomotive
+    headers:
+      User-Agent:
+      - Faraday v0.14.0
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Mon, 30 Apr 2018 08:02:00 GMT
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Content-Type:
+      - application/json
+      Etag:
+      - W/"2129738122b01b8471b44d9b5fa111ef"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - af61f926-8c2c-4de6-b2d4-227cfc2d36f1
+      X-Runtime:
+      - '0.021122'
+      Content-Length:
+      - '32'
+    body:
+      encoding: UTF-8
+      string: '{"token":"oTxs76hxMqHv6jyav1tw"}'
+    http_version: 
+  recorded_at: Mon, 30 Apr 2018 08:02:00 GMT
+- request:
+    method: get
+    uri: http://localhost:3000/locomotive/sample/api/v3/sections.json?auth_token=oTxs76hxMqHv6jyav1tw
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.14.0
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Mon, 30 Apr 2018 08:02:00 GMT
+      X-Locomotive-Account-Email:
+      - admin@locomotivecms.com
+      X-Locomotive-Account-Token:
+      - oTxs76hxMqHv6jyav1tw
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Etag:
+      - W/"490955a3a3e4e639bc53bcec098c7d71"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - d9ef8a4f-edac-4b91-9935-5d698ffeb79a
+      X-Runtime:
+      - '0.031445'
+      Content-Length:
+      - '1370'
+    body:
+      encoding: UTF-8
+      string: '[{"_id":"5ae629b4a95330361d619e92","created_at":"2018-04-29T20:23:16Z","updated_at":"2018-04-29T20:23:16Z","name":"Header","slug":"header","template":"\u003ch1\u003e
+        {{ section.settings.brand }} \u003c/h1\u003e\n\u003cul\u003e\n  {% for block
+        in section.blocks %}\n    \u003cli\u003e\n      \u003ca href=\"{{ block.settings.url
+        }}\" target=\"{% if block.settings.new_tab %}_blank{% endif %}\"\u003e\n        {{
+        block.settings.label }}\n      \u003c/a\u003e\n    \u003c/li\u003e\n  {% endfor
+        %}\n\u003c/ul\u003e\n","definition":{"category":"header","class":"section-header","default":{"blocks":[{"settings":{"label":"Link
+        #1","new_tab":"true","url":"https://www.nocoffee.fr"},"type":"link"},{"settings":{"label":"Link
+        #2","new_tab":"true","url":"https://www.nocoffee.fr"},"type":"link"}],"settings":{"brand":"MY
+        COMPANY"}},"name":"header","settings":[{"default":"Header","id":"brand","label":"Text
+        to display in the header","type":"text"}],"static":"true"}},{"_id":"5ae629b4a95330361d619e94","created_at":"2018-04-29T20:23:16Z","updated_at":"2018-04-29T20:23:16Z","name":"Carousel","slug":"carousel","template":"\u003ch2\u003e\n  FOOTER
+        PLAIN TEXT\n\u003c/h2\u003e\n","definition":{"category":"carousel","class":"section-carousel","name":"carousel","settings":[{"default":"Header","id":"brand","label":"Text
+        to display in the carousel","type":"text"}],"static":"false"}}]'
+    http_version: 
+  recorded_at: Mon, 30 Apr 2018 08:02:01 GMT
+- request:
+    method: post
+    uri: http://localhost:3000/locomotive/sample/api/v3/sections.json
+    body:
+      encoding: UTF-8
+      string: auth_token=oTxs76hxMqHv6jyav1tw&section%5Bdefinition%5D%5Bname%5D=sidebar&section%5Bdefinition%5D%5Bsettings%5D%5B0%5D%5Bid%5D=title&section%5Bdefinition%5D%5Bsettings%5D%5B0%5D%5Btype%5D=string&section%5Bname%5D=Sidebar&section%5Bslug%5D=sidebar&section%5Btemplate%5D=Locomotive+rocks%21
+    headers:
+      User-Agent:
+      - Faraday v0.14.0
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Mon, 30 Apr 2018 08:02:01 GMT
+      X-Locomotive-Account-Email:
+      - admin@locomotivecms.com
+      X-Locomotive-Account-Token:
+      - oTxs76hxMqHv6jyav1tw
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Content-Type:
+      - application/json
+      Etag:
+      - W/"19bceeabd505d7d296ba801379371a72"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 4aa8a696-79c8-4a72-8cb0-bee2d2baeda7
+      X-Runtime:
+      - '0.036655'
+      Content-Length:
+      - '247'
+    body:
+      encoding: UTF-8
+      string: '{"_id":"5ae6cd79e051bb388c4d8890","created_at":"2018-04-30T08:02:01Z","updated_at":"2018-04-30T08:02:01Z","name":"Sidebar","slug":"sidebar","template":"Locomotive
+        rocks!","definition":{"name":"sidebar","settings":[{"id":"title","type":"string"}]}}'
+    http_version: 
+  recorded_at: Mon, 30 Apr 2018 08:02:01 GMT
+- request:
+    method: put
+    uri: http://localhost:3000/locomotive/sample/api/v3/sections/5ae6cd79e051bb388c4d8890.json
+    body:
+      encoding: UTF-8
+      string: auth_token=oTxs76hxMqHv6jyav1tw&section%5Btemplate%5D=Locomotive+rocks.+period
+    headers:
+      User-Agent:
+      - Faraday v0.14.0
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Mon, 30 Apr 2018 08:02:01 GMT
+      X-Locomotive-Account-Email:
+      - admin@locomotivecms.com
+      X-Locomotive-Account-Token:
+      - oTxs76hxMqHv6jyav1tw
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Etag:
+      - W/"da36f1d7680992a2a7167dcc17772d51"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 81cf8bcd-6d14-4743-9d1b-39c360b2d50c
+      X-Runtime:
+      - '0.033459'
+      Content-Length:
+      - '254'
+    body:
+      encoding: UTF-8
+      string: '{"_id":"5ae6cd79e051bb388c4d8890","created_at":"2018-04-30T08:02:01Z","updated_at":"2018-04-30T08:02:01Z","name":"Sidebar","slug":"sidebar","template":"Locomotive
+        rocks. period","definition":{"name":"sidebar","settings":[{"id":"title","type":"string"}]}}'
+    http_version: 
+  recorded_at: Mon, 30 Apr 2018 08:02:01 GMT
+- request:
+    method: delete
+    uri: http://localhost:3000/locomotive/sample/api/v3/sections/5ae6cd79e051bb388c4d8890.json?auth_token=oTxs76hxMqHv6jyav1tw
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.14.0
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Mon, 30 Apr 2018 08:02:01 GMT
+      X-Locomotive-Account-Email:
+      - admin@locomotivecms.com
+      X-Locomotive-Account-Token:
+      - oTxs76hxMqHv6jyav1tw
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Etag:
+      - W/"da36f1d7680992a2a7167dcc17772d51"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 8e5bb871-c8bc-4794-bfd7-c6c5944eb899
+      X-Runtime:
+      - '0.028105'
+      Content-Length:
+      - '254'
+    body:
+      encoding: UTF-8
+      string: '{"_id":"5ae6cd79e051bb388c4d8890","created_at":"2018-04-30T08:02:01Z","updated_at":"2018-04-30T08:02:01Z","name":"Sidebar","slug":"sidebar","template":"Locomotive
+        rocks. period","definition":{"name":"sidebar","settings":[{"id":"title","type":"string"}]}}'
+    http_version: 
+  recorded_at: Mon, 30 Apr 2018 08:02:01 GMT
+recorded_with: VCR 4.0.0

data/spec/integration/resources/sections_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Locomotive::Coal::Resources::Sections, order: :defined do
+
+  before { VCR.insert_cassette 'sections', record: :new_episodes }
+  after  { VCR.eject_cassette }
+
+  let(:uri)         { TEST_SITE_API_V3_URI }
+  let(:credentials) { { email: TEST_API_EMAIL, token: api_token } }
+  let(:sections)    { described_class.new(uri, credentials) }
+
+  describe '#all' do
+    subject { sections.all }
+    it { expect(subject).not_to eq nil }
+  end
+
+  describe '#create' do
+    subject { create_section }
+    it { expect(subject._id).not_to eq nil }
+  end
+
+  describe '#update' do
+    let(:section) { sections.all.detect { |s| s.slug == 'sidebar' } || create_section }
+    subject { sections.update(section._id, template: 'Locomotive rocks. period') }
+    it { expect(subject.template).to eq 'Locomotive rocks. period' }
+  end
+
+  describe '#destroy' do
+    let(:section) { sections.all.detect { |s| s.slug == 'sidebar' } || create_section }
+    subject { sections.destroy(section._id) }
+    it { expect(subject._id).not_to eq nil }
+  end
+
+  def create_section
+    sections.create(name: 'Sidebar', slug: 'sidebar', template: 'Locomotive rocks!', definition: {
+      name: 'sidebar',
+      settings: [
+        {
+          id:   'title',
+          type: 'string'
+        }
+      ]
+    })
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locomotivecms_coal
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0.beta1
 platform: ruby
 authors:
 - Didier Lafforgue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-03 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.4
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,22 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +145,7 @@ files:
 - lib/locomotive/coal/resources/memberships.rb
 - lib/locomotive/coal/resources/my_account.rb
 - lib/locomotive/coal/resources/pages.rb
+- lib/locomotive/coal/resources/sections.rb
 - lib/locomotive/coal/resources/sites.rb
 - lib/locomotive/coal/resources/snippets.rb
 - lib/locomotive/coal/resources/theme_assets.rb
@@ -157,6 +164,7 @@ files:
 - spec/fixtures/coal_cassettes/memberships.yml
 - spec/fixtures/coal_cassettes/my_account.yml
 - spec/fixtures/coal_cassettes/pages.yml
+- spec/fixtures/coal_cassettes/sections.yml
 - spec/fixtures/coal_cassettes/sites.yml
 - spec/fixtures/coal_cassettes/snippets.yml
 - spec/fixtures/coal_cassettes/theme_assets.yml
@@ -172,6 +180,7 @@ files:
 - spec/integration/resources/memberships_spec.rb
 - spec/integration/resources/my_account_spec.rb
 - spec/integration/resources/pages_spec.rb
+- spec/integration/resources/sections_spec.rb
 - spec/integration/resources/sites_spec.rb
 - spec/integration/resources/snippets_spec.rb
 - spec/integration/resources/theme_assets_spec.rb
@@ -203,9 +212,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3
@@ -223,6 +232,7 @@ test_files:
 - spec/fixtures/coal_cassettes/memberships.yml
 - spec/fixtures/coal_cassettes/my_account.yml
 - spec/fixtures/coal_cassettes/pages.yml
+- spec/fixtures/coal_cassettes/sections.yml
 - spec/fixtures/coal_cassettes/sites.yml
 - spec/fixtures/coal_cassettes/snippets.yml
 - spec/fixtures/coal_cassettes/theme_assets.yml
@@ -238,6 +248,7 @@ test_files:
 - spec/integration/resources/memberships_spec.rb
 - spec/integration/resources/my_account_spec.rb
 - spec/integration/resources/pages_spec.rb
+- spec/integration/resources/sections_spec.rb
 - spec/integration/resources/sites_spec.rb
 - spec/integration/resources/snippets_spec.rb
 - spec/integration/resources/theme_assets_spec.rb