locomotivecms_coal 1.6.0.rc1 → 1.6.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 016e54d25e92d2c847f04ab46c99a6f1210b10d809c645df1f6d722eeb334818
-  data.tar.gz: 1c292c1f79940c8e0aeaf1f3aadb7695c8b9e16eec2ac7db0b28021927648596
+  metadata.gz: 0cffc656b10f31319f68a44c11bba6d9d03efb69e82b352ab2ac1efbf5275f90
+  data.tar.gz: 194621c054114cdc1f98c13fa9e06624f69174aa181e06f3923535bd29657872
 SHA512:
-  metadata.gz: 62cfb52c463a62bc09983389dde1a7988fee31c2beb8691aa5398adabfc79ee859e5990260707a3f3bbb97df4c20e6a1296879aaac68e8f5f5bb4bdf25309eae
-  data.tar.gz: 2d9437086ce85442e17679eafa0a37499b9c39d68fe10d0a0843f5b5b328ee0ce1dc4efafb682ad86293e9b1a3a10c660d01c0a0ca3222fbc47cad31966d2f39
+  metadata.gz: f0f133d320ae1e222cae3f9c27dc6c476f4e67bfda9aa53496dd3cd9a39543f7ab31833d0d411120b53b2e05a9fe2dc46f983937d1826b29b1d006e9c9a537c9
+  data.tar.gz: 7e3a9abbf3e50eb7b3173c0a0479b6c42b6abc7f1ae28add3437a88dafbd08d39bbfa8df7d4e3dd1cb2e155e8353c14f1d7c6e319f34d13770554f4bd5a602d4

data/.gitignore

@@ -1,3 +1,4 @@
 coverage/
 pkg/
 .DS_Store
+.ruby-version

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.5.0
+  - 2.6.5
 env:
   - CODECLIMATE_REPO_TOKEN=8d9c25de4eff1cd06d3accdc09775397e1a81be67e2a159453ba4e4408acae16
 addons:

data/Gemfile

@@ -19,7 +19,3 @@ group :test do
   gem 'codeclimate-test-reporter',  '~> 1.0.7',  require: false
   gem 'coveralls',                  '~> 0.8.19', require: false
 end
-
-platform :ruby do
-  ruby '2.5.0'
-end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    locomotivecms_coal (1.6.0.rc1)
-      activesupport (>= 5.1.5, < 6.0)
+    locomotivecms_coal (1.6.0.rc2)
+      activesupport (>= 5.1.5, <= 6.0)
       faraday (~> 0.15.4)
       faraday_middleware (~> 0.13.1)
       httpclient (~> 2.8.3)
@@ -11,11 +11,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (6.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     byebug (9.0.6)
@@ -43,7 +44,7 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     httpclient (2.8.3)
-    i18n (1.6.0)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
     json_spec (1.1.5)
@@ -53,7 +54,7 @@ GEM
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
-    minitest (5.11.3)
+    minitest (5.13.0)
     multi_json (1.13.1)
     multipart-post (2.1.1)
     netrc (0.11.0)
@@ -103,6 +104,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
+    zeitwerk (2.2.1)
 
 PLATFORMS
   ruby
@@ -119,8 +121,5 @@ DEPENDENCIES
   vcr
   webmock
 
-RUBY VERSION
-   ruby 2.5.0p0
-
 BUNDLED WITH
    1.17.3

data/MIT-LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 NoCoffee
+Copyright (c) 2019 NoCoffee
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -11,6 +11,7 @@ The Ruby API Client for LocomotiveCMS V3.
   - [Authentication](#authentication)
   - [Resources](#resources)
       - [MyAccount](#my-account)
+      - [Accounts](#accounts)
       - [Sites](#sites)
       - [Pages](#pages)
       - [Content Types](#content-types)
@@ -69,6 +70,19 @@ We do not garantee that all the API resources will work with the V2 Client but P
 
     client.my_account.update(name: 'Jane Doe')
 
+#### Accounts
+
+**Only available for super administrators in the LocomotiveCMS engine**
+
+**Create**
+
+    new_customer = client.accounts.create(name: 'John', email: 'johnn@doe.net', password: 'easyone', password_confirmation: 'easyone')
+    puts new_customer.name + " / " + my_account.email
+
+**Update an account**
+
+    client.accounts.update(new_customer._id, name: 'Jane')
+
 #### Sites
 
 **Get all my sites**
@@ -149,7 +163,7 @@ It is required when we need the id of an existing page according to its fullpath
 
 *Note:* You can also use the following syntax
 
-    content_type = site_client.contents.projects
+    content_type = site_client.contents.by_slug('projects')
     articles = site_client.content_entries(content_type).all
 
 **Create a content entry**
@@ -282,7 +296,7 @@ To get the snippets in the FR locale:
 
 **Update a membership**
 
-    site_client.memberships.update(account_email: 'nic@example.com', role: 'admin')
+    site_client.memberships.update(membership._id, role: 'designer')
 
 **Destroy a membership**
 
@@ -316,10 +330,11 @@ Check the issues section of the repository to see what is missing.
 - edit your /etc/hosts file (*NIX systems) and add 2 lines
       127.0.0.0     www.example.com acme.example.com
 
+
 ## Credits
 
 [Christian](https://github.com/cblavier), [Greg](https://github.com/gregKawet) and [Ben](https://github.com/stiiig) from the Cogip/Insert International LTD who brainstormed with me (a very long time) to find this awesome name.
 
 ## License
 
-Copyright (c) 2018 NoCoffee. MIT Licensed, see LICENSE for details.
+Copyright (c) 2019 NoCoffee. MIT Licensed, see LICENSE for details.

data/lib/locomotive/coal/client.rb

@@ -21,10 +21,18 @@ module Locomotive::Coal
       @my_account ||= Resources::MyAccount.new(uri, connection)
     end
 
+    def accounts
+      @accounts ||= Resources::Accounts.new(uri, connection)
+    end
+
     def sites
       @sites ||= Resources::Sites.new(uri, connection)
     end
 
+    def memberships
+      @memberships ||= Resources::Memberships.new(uri, connection)
+    end
+
     def current_site
       @current_site ||= Resources::CurrentSite.new(uri, connection)
     end

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

@@ -0,0 +1,33 @@
+module Locomotive::Coal
+  module Resources
+
+    class Accounts < Base
+
+      def index(query = nil, options = {})
+        parameters = { where: (query || {}).to_json }.merge(options || {})
+
+        response = get(resources_name, parameters, true)
+
+        list = response.body.map { |attributes| Resource.new(attributes) }
+
+        PaginatedResources.new(list,
+          options[:page] || 1,
+          response.headers[:x_total_pages].to_i,
+          response.headers[:x_total_entries].to_i)
+      end
+
+      def each(query = nil, options = nil, &block)
+        page = 1
+        while page do
+          resources = all(query, (options || {}).merge(page: page))
+          resources.each(&block)
+          page = resources._next_page
+        end
+      end
+
+      alias :all :index
+
+    end
+
+  end
+end

data/lib/locomotive/coal/resources/concerns/request.rb

@@ -20,10 +20,28 @@ module Locomotive::Coal::Resources
       end
 
       def do_request(action, endpoint, parameters = {}, raw = false)
+        max_count = 5
         response = begin
+          # Just uncomment following line if you want to trace protocol between wagon & engine live
+          # puts "#{parameters}"
           _do_request(action, "#{uri.path}/#{endpoint}.json", parameters)
         rescue ::Timeout::Error, ::Errno::ETIMEDOUT, Faraday::Error::TimeoutError => e
-          raise Locomotive::Coal::TimeoutError.new(e)
+          if max_count > 0
+            puts "\n Warning => timeout detected, attempts left: #{max_count}\n\n"
+            max_count -= 1
+            retry
+          else
+            raise Locomotive::Coal::TimeoutError.new(e)
+          end
+        rescue HTTPClient::KeepAliveDisconnected => e
+          if max_count > 0
+            puts "\n Warning => HTTPClient::KeepAliveDisconnected exception detected, attempts left: #{max_count}\n\n"
+            max_count -= 1
+            retry
+          else
+            puts "\n Error => HTTPClient::KeepAliveDisconnected exception detected, attempts left zero... raising exception\n\n"
+            raise HTTPClient::KeepAliveDisconnected.new(e)
+          end
         rescue Locomotive::Coal::Error
           raise
         rescue Exception => e

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.6.0.rc1'
+    VERSION = '1.6.0.rc2'
   end
 end

data/lib/locomotive/coal.rb

@@ -18,6 +18,7 @@ require_relative 'coal/resource'
 require_relative 'coal/resources/base'
 require_relative 'coal/resources/token'
 require_relative 'coal/resources/my_account'
+require_relative 'coal/resources/accounts'
 require_relative 'coal/resources/sites'
 require_relative 'coal/resources/current_site'
 require_relative 'coal/resources/pages'

data/locomotivecms_coal.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'httpclient',             '~> 2.8.3'
   spec.add_dependency 'faraday',                '~> 0.15.4'
   spec.add_dependency 'faraday_middleware',     '~> 0.13.1'
-  spec.add_dependency 'activesupport',          '>= 5.1.5', '< 6.0'
+  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/accounts.yml

@@ -0,0 +1,214 @@
+---
+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.15.4
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Sun, 17 Nov 2019 16:39:31 GMT
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '32'
+      Connection:
+      - keep-alive
+      Status:
+      - 201 Created
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Etag:
+      - W/"410e3d6fde24f39257a7cc619b61baa7"
+      X-Runtime:
+      - '0.003847'
+      X-Request-Id:
+      - 37641f2b-e3b4-4c75-a947-67001077f519
+      Date:
+      - Sun, 17 Nov 2019 16:39:31 GMT
+      X-Powered-By:
+      - Phusion Passenger 6.0.4
+      Server:
+      - nginx/1.17.3 + Phusion Passenger 6.0.4
+    body:
+      encoding: UTF-8
+      string: '{"token":"bzwAyFQzcchf_hgDQhz3"}'
+    http_version: 
+  recorded_at: Sun, 17 Nov 2019 16:39:31 GMT
+- request:
+    method: get
+    uri: http://localhost:3000/locomotive/api/v3/accounts.json?auth_token=bzwAyFQzcchf_hgDQhz3&where=%7B%7D
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.4
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Sun, 17 Nov 2019 16:39:31 GMT
+      X-Locomotive-Account-Email:
+      - admin@locomotivecms.com
+      X-Locomotive-Account-Token:
+      - bzwAyFQzcchf_hgDQhz3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Etag:
+      - W/"b45c198e9ff3646c60b8055f5230fe83"
+      X-Runtime:
+      - '0.011734'
+      X-Request-Id:
+      - 5467f046-9d4c-49af-86aa-3ac502e50b13
+      Date:
+      - Sun, 17 Nov 2019 16:39:31 GMT
+      X-Powered-By:
+      - Phusion Passenger 6.0.4
+      Server:
+      - nginx/1.17.3 + Phusion Passenger 6.0.4
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: UTF-8
+      string: '[{"_id":"5dd1779ba95330a94bf7253c","created_at":"2019-11-17T16:38:51Z","updated_at":"2019-11-17T16:39:30Z","name":"John
+        Doe","email":"admin@locomotivecms.com","locale":"en","api_key":"d49cd50f6f0d2b163f48fc73cb249f0244c37074","super_admin":true,"local_admin":true},{"_id":"5dd1779ba95330a94bf7253d","created_at":"2019-11-17T16:38:51Z","updated_at":"2019-11-17T16:38:51Z","name":"New
+        Admin","email":"new_admin@locomotivecms.com","locale":"en","api_key":"d49cd50f6f0d2b163f48fc73cb249f0244c37074","super_admin":false,"local_admin":false},{"_id":"5dd177c2a95330aa17f8f8df","created_at":"2019-11-17T16:39:30Z","updated_at":"2019-11-17T16:39:30Z","name":"Jack
+        Doe","email":"jack@doe.net","locale":"en","api_key":"b99855e630e7510ee902e0871f213328cfcbc552","super_admin":false,"local_admin":false}]'
+    http_version: 
+  recorded_at: Sun, 17 Nov 2019 16:39:31 GMT
+- request:
+    method: post
+    uri: http://localhost:3000/locomotive/api/v3/accounts.json
+    body:
+      encoding: UTF-8
+      string: account%5Bemail%5D=jane%40doe.net&account%5Bname%5D=Jane&account%5Bpassword%5D=easyone&account%5Bpassword_confirmation%5D=easyone&auth_token=bzwAyFQzcchf_hgDQhz3
+    headers:
+      User-Agent:
+      - Faraday v0.15.4
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Sun, 17 Nov 2019 16:39:32 GMT
+      X-Locomotive-Account-Email:
+      - admin@locomotivecms.com
+      X-Locomotive-Account-Token:
+      - bzwAyFQzcchf_hgDQhz3
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '250'
+      Connection:
+      - keep-alive
+      Status:
+      - 201 Created
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Etag:
+      - W/"93c7e6382bd0ad95a3e47fac8db86283"
+      X-Runtime:
+      - '0.014507'
+      X-Request-Id:
+      - 4643a202-a742-423f-8f83-a39b66034328
+      Date:
+      - Sun, 17 Nov 2019 16:39:32 GMT
+      X-Powered-By:
+      - Phusion Passenger 6.0.4
+      Server:
+      - nginx/1.17.3 + Phusion Passenger 6.0.4
+    body:
+      encoding: UTF-8
+      string: '{"_id":"5dd177c4a95330aa17f8f8e7","created_at":"2019-11-17T16:39:32Z","updated_at":"2019-11-17T16:39:32Z","name":"Jane","email":"jane@doe.net","locale":"en","api_key":"55ce1c667d4da4509641fc5bcecd8e4542b72d76","super_admin":false,"local_admin":false}'
+    http_version: 
+  recorded_at: Sun, 17 Nov 2019 16:39:32 GMT
+- request:
+    method: delete
+    uri: http://localhost:3000/locomotive/api/v3/accounts/5dd177c4a95330aa17f8f8e7.json?auth_token=bzwAyFQzcchf_hgDQhz3
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.4
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Sun, 17 Nov 2019 16:39:32 GMT
+      X-Locomotive-Account-Email:
+      - admin@locomotivecms.com
+      X-Locomotive-Account-Token:
+      - bzwAyFQzcchf_hgDQhz3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Etag:
+      - W/"93c7e6382bd0ad95a3e47fac8db86283"
+      X-Runtime:
+      - '0.019832'
+      X-Request-Id:
+      - 5e0ae3a4-71ea-4235-aaf4-1ce98404e225
+      Date:
+      - Sun, 17 Nov 2019 16:39:32 GMT
+      X-Powered-By:
+      - Phusion Passenger 6.0.4
+      Server:
+      - nginx/1.17.3 + Phusion Passenger 6.0.4
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: UTF-8
+      string: '{"_id":"5dd177c4a95330aa17f8f8e7","created_at":"2019-11-17T16:39:32Z","updated_at":"2019-11-17T16:39:32Z","name":"Jane","email":"jane@doe.net","locale":"en","api_key":"55ce1c667d4da4509641fc5bcecd8e4542b72d76","super_admin":false,"local_admin":false}'
+    http_version: 
+  recorded_at: Sun, 17 Nov 2019 16:39:32 GMT
+recorded_with: VCR 4.0.0