locomotivecms_coal 1.0.0.pre.alpha.3 → 1.0.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2d33fc0152aa303a2de3a82826a9b4b3d153ff8
-  data.tar.gz: 5d9720c5e28c435a0b0d299eb437477779deaf33
+  metadata.gz: 5d3bba571ef565ff121673ddae199ba423c19159
+  data.tar.gz: f9fa0cb7d2455455122c710b32f7d54bfdbae34f
 SHA512:
-  metadata.gz: 492dda6e3af90dd2438d0a3f4f5057bd4aa4e449fbe22e5945369cb60da0e59e4016759267572b96e1657aaad14228a8bf971ba190c677836c622c09ba69cfca
-  data.tar.gz: e13be9b37035568852e0484e18a89dbb1094b46624059a3efce9387cf197d88a0639aba03d9be8fa2798c2e91cb7c07ccbff2b92584e4c8e5369d7a605a15e6f
+  metadata.gz: 875b5f487b4d2547210e50e4f444238dd4bf9453d9e5d3ef58d4ec9e19033f61ab0e3ad0f0b78b67a26ef4cad4921018bf614dc349814025a17aed86ca0c4088
+  data.tar.gz: 1f718e96033b2b03df927b3a8dfb17b04ccb5e24c6cbd4a118aadd5d178332f46d3953acc211670b1fee4f6dd0e60ec91d2c57350c69386ef2b0fb14599f5057

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    locomotivecms_coal (1.0.0.pre.alpha.3)
-      activesupport (~> 4.2.1)
+    locomotivecms_coal (1.0.0.pre.beta.1)
+      activesupport (~> 4.2.3)
       faraday (~> 0.9.1)
-      faraday_middleware (~> 0.9.1)
+      faraday_middleware (~> 0.10.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.1)
+    activesupport (4.2.3)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -36,18 +36,18 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.9.1)
+    faraday_middleware (0.10.0)
       faraday (>= 0.7.4, < 0.10)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
     i18n (0.7.0)
-    json (1.8.2)
+    json (1.8.3)
     json_spec (1.1.4)
       multi_json (~> 1.0)
       rspec (>= 2.0, < 4.0)
     method_source (0.8.2)
     mime-types (2.4.3)
-    minitest (5.6.1)
+    minitest (5.7.0)
     multi_json (1.11.0)
     multipart-post (2.0.0)
     netrc (0.10.3)

data/README.md

@@ -18,6 +18,8 @@ The Ruby API Client for LocomotiveCMS V3 (WIP).
       - [Snippets](#snippets)
       - [Theme Assets](#theme-assets)
       - [Content Assets](#content-assets)
+      - [Translations](#translations)
+      - [Memberships](#memberships)
 - [What is missing](#todo)
 - [Contributing](#contributing)
 - [How to write specs](#how-to-write-specs)
@@ -30,6 +32,10 @@ The Ruby API Client for LocomotiveCMS V3 (WIP).
 
 ## Usage
 
+First, load the gem:
+
+    require 'locomotive/coal'
+
 ### Authentication
 
     client = Locomotive::Coal::Client.new('http://www.myengine.dev', { email: <EMAIL>, api_key: <API KEY> })
@@ -38,7 +44,11 @@ You can get the version of the remote running Engine by calling the following me
 
     client.engine_version
 
-*Note:* Coal only supports Engine version **~> 3.0.0**.
+*Note:* Coal supports Engine version **~> 3.0.x**. However, if you do need to request an Engine running a 2.5.x version, use following code instead:
+
+    client = Locomotive::Coal::ClientV2.new('http://www.myengine.dev', { email: <EMAIL>, api_key: <API KEY> })
+
+We do not garantee that all the API resources will work with the V2 Client but PRs are accepted of course.
 
 ### Resources
 
@@ -77,9 +87,17 @@ You can get the version of the remote running Engine by calling the following me
 
 *Note:* We first need to log in to the site. It can be done by calling the scope_by method of the client instance.
 
-    site = client.sites.by_subdomain('acme')
+    site = client.sites.by_handle('acme')
     site_client = client.scope_by(site)
 
+Or, in a shorter way:
+
+    site_client = client.scope_by('acme')
+
+For the **V2 Client**, that would be this instead:
+
+    site = client.sites.by_subdomain('acme')
+
 **Get the list of pages in English**
 
     pages = site_client.pages.all(:en)
@@ -160,6 +178,10 @@ It is required when we need the id of an existing page according to its fullpath
 
     snippets = site_client.snippets.all
 
+To get the snippets in the FR locale:
+
+    snippets_in_french = site_client.snippets.all('fr')
+
 **Create a snippet**
 
     snippet = site_client.snippets.create(name: 'Header', slug: 'header', template: 'Locomotive rocks!')
@@ -212,9 +234,44 @@ It is required when we need the id of an existing page according to its fullpath
 
     site_client.content_assets.destroy(asset._id)
 
+#### Translations
+
+**Get the list of translations**
+
+    translations = site_client.translations.all
+
+**Create a translation**
+
+    translation = site_client.translations.create(key: 'hello_world', values: { en: 'Hello world!', fr: 'Bonjour monde' })
+
+**Update a translation**
+
+    site_client.translations.update(translation._id, values: { en: 'Hello world!!!', fr: 'Bonjour monde !!!'} ))
+
+**Destroy a translation**
+
+    site_client.translations.destroy(translation._id)
+
+#### Memberships
+**Get the list of memberships**
+
+    memberships = site_client.memberships.all
+
+**Create a membership**
+
+    membership = site_client.memberships.create(role: 'author', account_email: 'nic@example.com')
+
+**Update a membership**
+
+    site_client.memberships.update(account_email: 'nic@example.com', role: 'admin')
+
+**Destroy a membership**
+
+    site_client.memberships.destroy(membership._id)
+
 ## What is missing?
 
-We only implemented a few resources (my_account, sites, content types and content entries) and for some of them, not all the actions have been implemented.
+We only implemented a few resources (my_account, sites, content types, memberships and content entries) and for some of them, not all the actions have been implemented.
 
 Check the issues section of the repository to see what is missing.
 

data/lib/locomotive/coal/client.rb

@@ -25,6 +25,10 @@ module Locomotive::Coal
       @sites ||= Resources::Sites.new(uri, connection)
     end
 
+    def current_site
+      @current_site ||= Resources::CurrentSite.new(uri, connection)
+    end
+
     def pages
       @pages ||= Resources::Pages.new(uri, connection)
     end
@@ -62,13 +66,16 @@ module Locomotive::Coal
 
     alias version engine_version
 
-    def scope_by(site)
-      options[:handle] = site.handle
+    def scope_by(site_or_handle)
+      if site_or_handle.respond_to?(:handle)
+        @current_site, site_or_handle = site_or_handle, site_or_handle.handle
+      end
+      options[:handle] = site_or_handle
       self
     end
 
     def reset
-      @token = @my_account = @sites = @pages = @content_types = @theme_assets = @content_assets = @translations = nil
+      @token = @my_account = @sites = @current_site = @pages = @content_types = @theme_assets = @content_assets = @translations = nil
     end
 
     def ssl?

data/lib/locomotive/coal/error.rb

@@ -51,7 +51,7 @@ module Locomotive::Coal
     private
 
     def build_message
-      attributes = body['attributes'].map do |name, errors|
+      attributes = (body['attributes'] || body).map do |name, errors|
         if errors.is_a?(Hash)
           errors.map do |k, _errors|
             "#{name}.#{k}: #{_errors.join(' + ')}"
@@ -59,8 +59,9 @@ module Locomotive::Coal
         else
           "#{name} #{errors.join(' ')}"
         end
-      end
-      "#{body['error']}: #{attributes.join(', ')}"
+      end.join(', ')
+
+      body['error'] ? "#{body['error']}: #{attributes}" : attributes
     end
 
   end

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

@@ -53,10 +53,10 @@ module Locomotive::Coal::Resources
         _connection.send(action, endpoint) do |request|
           request.headers = _request_headers(parameters)
 
-          if %i(create update).include?(action)
-            request.params = parameters
-          else
+          if %i(post put).include?(action)
             request.body = parameters
+          else
+            request.params = parameters
           end
         end
       end

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

@@ -25,6 +25,15 @@ module Locomotive::Coal
           response.headers[:x_total_entries].to_i)
       end
 
+      def each(query = nil, options = nil, locale = nil, &block)
+        page = 1
+        while page do
+          resources = all(query, (options || {}).merge(page: page), locale)
+          resources.each(&block)
+          page = resources._next_page
+        end
+      end
+
       alias :all :index
 
       alias :update :update_with_locale

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

@@ -0,0 +1,25 @@
+module Locomotive::Coal
+  module Resources
+
+    class CurrentSite < Struct.new(:uri, :credentials)
+
+      include Concerns::Request
+
+      def get(locale = nil)
+        Resource.new(super('current_site', _locale: locale))
+      end
+
+      def update(attributes = {})
+        data = put('current_site', site: attributes)
+        Resource.new(data)
+      end
+
+      def destroy
+        data = delete('current_site')
+        Resource.new(data)
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,13 @@
+module Locomotive::Coal
+  module Resources
+
+    class Memberships < Base
+
+      # for create, accept email address.
+
+      alias :all :index
+
+    end
+
+  end
+end

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

@@ -3,7 +3,7 @@ module Locomotive::Coal
 
     class Pages < Base
 
-      def index(locale)
+      def index(locale = nil)
         get(resources_name, _locale: locale).map do |attributes|
           Resource.new(attributes)
         end

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

@@ -3,6 +3,14 @@ module Locomotive::Coal
 
     class Snippets < Base
 
+      def index(locale = nil)
+        get(resources_name, _locale: locale).map do |attributes|
+          Resource.new(attributes)
+        end
+      end
+
+      alias :all :index
+
     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.0.0-alpha.3'
+    VERSION = '1.0.0-beta.1'
   end
 end

data/lib/locomotive/coal.rb

@@ -18,6 +18,7 @@ require_relative 'coal/resources/base'
 require_relative 'coal/resources/token'
 require_relative 'coal/resources/my_account'
 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/content_assets'
@@ -26,4 +27,6 @@ require_relative 'coal/resources/translations'
 require_relative 'coal/resources/content_types'
 require_relative 'coal/resources/content_entries'
 require_relative 'coal/resources/engine_version'
+require_relative 'coal/resources/memberships'
 require_relative 'coal/client'
+require_relative 'coal/client_v2'

data/locomotivecms_coal.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake',       '~> 10.4.2'
 
   spec.add_dependency 'faraday',                '~> 0.9.1'
-  spec.add_dependency 'faraday_middleware',     '~> 0.9.1'
-  spec.add_dependency 'activesupport',          '~> 4.2.1'
+  spec.add_dependency 'faraday_middleware',     '~> 0.10.0'
+  spec.add_dependency 'activesupport',          '~> 4.2.3'
 
   spec.required_ruby_version = '>= 2.0'
 end