locomotivecms_coal 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 259ae27071883220aca274191042f544e80df7c2
+  data.tar.gz: f29a3c015fc1ce549bf8b33564456db6a5cf881f
+SHA512:
+  metadata.gz: f95b87e05a3311b40609f859cd2c3e3afbe60f0ad7939f2db0299f789bf3584bdc9f7bf4d1c7da00cc4959fd332850fa132682bf501c0ce6135b62102f1e6813
+  data.tar.gz: 33e434030b8dbdd97f9ad3fce0c07a7a6631b0af891bed7847dafdd6d27c45a96c35abfac51f8ad4e0b0f6cfbb7c0b8a190b93d3d57eeb4ce73ee32d85a059c2

data/.gitignore

@@ -0,0 +1 @@
+coverage/

data/.rspec

@@ -0,0 +1,2 @@
+--format=doc
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.0
+env:
+  - CODECLIMATE_REPO_TOKEN=8d9c25de4eff1cd06d3accdc09775397e1a81be67e2a159453ba4e4408acae16
+addons:
+  code_climate:
+    repo_token: 8d9c25de4eff1cd06d3accdc09775397e1a81be67e2a159453ba4e4408acae16

data/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+end
+
+group :test do
+  gem 'rspec',              '~> 3.2.0'
+  gem 'json_spec',          '~> 1.1.4'
+
+  gem 'pry-byebug',         '~> 3.1.0'
+
+  gem 'webmock'
+  gem 'vcr'
+
+  gem 'codeclimate-test-reporter',  '~> 0.4.7',  require: false
+  gem 'coveralls',                  '~> 0.7.11', require: false
+end
+
+platform :ruby do
+  ruby '2.2.0'
+end

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    locomotivecms_coal (1.0.0.pre.alpha)
+      activesupport (~> 4.2.1)
+      unirest (~> 1.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.7)
+    byebug (4.0.3)
+      columnize (= 0.9.0)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    coveralls (0.7.12)
+      multi_json (~> 1.10)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.2)
+    json_spec (1.1.4)
+      multi_json (~> 1.0)
+      rspec (>= 2.0, < 4.0)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (5.5.1)
+    multi_json (1.11.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.1.0)
+      byebug (~> 4.0)
+      pry (~> 0.10)
+    rake (10.4.2)
+    rdoc (4.2.0)
+    rest-client (1.6.8)
+      mime-types (~> 1.16)
+      rdoc (>= 2.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    safe_yaml (1.0.4)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unirest (1.1.2)
+      addressable (~> 2.3.5)
+      json (~> 1.8.1)
+      rest-client (~> 1.6.7)
+    vcr (2.9.3)
+    webmock (1.9.3)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9.1)
+  codeclimate-test-reporter (~> 0.4.7)
+  coveralls (~> 0.7.11)
+  json_spec (~> 1.1.4)
+  locomotivecms_coal!
+  pry-byebug (~> 3.1.0)
+  rake (~> 10.4.2)
+  rspec (~> 3.2.0)
+  vcr
+  webmock

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 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
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# Coal
+
+[![Code Climate](https://codeclimate.com/github/locomotivecms/coal/badges/gpa.svg)](https://codeclimate.com/github/locomotivecms/coal) [![Dependency Status](https://gemnasium.com/locomotivecms/coal.svg)](https://gemnasium.com/locomotivecms/coal) [![Build Status](https://travis-ci.org/locomotivecms/coal.svg?branch=master)](https://travis-ci.org/locomotivecms/coal) [![Coverage Status](https://coveralls.io/repos/locomotivecms/coal/badge.svg?branch=master)](https://coveralls.io/r/locomotivecms/coal?branch=master)
+
+The Ruby API Client for LocomotiveCMS.
+
+## Installation [WIP]
+
+    gem install locomotivecms_coal --pre
+
+## Usage
+
+### Authentication
+
+    client = Locomotive::Coal::Client.new('http://www.myengine.dev/locomotive/api', { email: <EMAIL>, api_key: <API KEY> })
+
+### Resources
+
+#### MyAccount
+
+**Get the name of the logged in account**
+
+    my_account = client.my_account.get
+    puts my_account.name + " / " + my_account.email
+
+#### Sites
+
+**Get all my sites**
+
+    my_sites = client.sites.all
+    puts "I've got #{my_sites.size}"
+
+**Create a new site**
+
+    my_site = client.sites.create(name: 'Acme', subdomain: 'acme', locales: ['en'], timezone: 'UTC')
+
+**Destroy a site**
+
+    my_site = client.sites.destroy(my_site._id)
+
+#### Content Types
+
+**Get a content type by its slug**
+
+*Note:* We first need to log in to the site the content type belongs to. It can be done by calling the scope_by method of the client instance.
+
+    site = client.sites.by_subdomain('acme')
+    site_client = client.scope_by(site)
+
+    content_type = site_client.contents.projects
+
+#### Content Entries
+
+**Get all the first 10 entries filtered by a property (published)**
+
+    articles = site_client.contents.articles.all({ published: true })
+
+**Loop over all the content entries**
+
+    page = 1
+    while page do
+      articles = site_client.contents.articles.all({ published: true }, page: page)
+      articles.each { |article| puts article.title }
+      page = articles._next_page
+    end
+
+**Update a content entry**
+
+    article = site_client.contents.articles.all.first
+    site_client.contents.articles.update(article._id, { title: 'Hello world'})
+
+## TODO
+
+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.
+
+Check the issues section of the repository to see what is missing.
+
+## 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.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/locomotivecms/coal )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2015 NoCoffee. MIT Licensed, see LICENSE for details.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler/setup'
+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'
+RSpec::Core::RakeTask.new('spec')
+
+RSpec::Core::RakeTask.new('spec:integration') do |spec|
+  spec.pattern = 'spec/integration/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new('spec:unit') do |spec|
+  spec.pattern = 'spec/unit/**/*_spec.rb'
+end
+
+task default: [:spec]

data/lib/locomotive/coal/client.rb

@@ -0,0 +1,53 @@
+module Locomotive::Coal
+
+  class Client
+
+    attr_reader :uri, :credentials
+
+    attr_accessor :scoped_by_site
+
+    def initialize(uri, credentials)
+      if uri.blank? || credentials.blank?
+        raise MissingURIOrCredentialsError.new('URI and/or credentials are missing')
+      else
+        @uri, @credentials = URI(uri), credentials
+      end
+    end
+
+    def token
+      @token ||= Resources::Token.new(uri, credentials).get
+    end
+
+    def my_account
+      @my_account ||= Resources::MyAccount.new(uri, token)
+    end
+
+    def sites
+      @sites ||= Resources::Sites.new(uri, token)
+    end
+
+    def contents
+      @contents ||= Resources::Contents.new(uri, token)
+    end
+
+    def scope_by(site)
+      if site.domains.include?(domain)
+        self
+      else
+        new_uri = site.domains.first
+        self.class.new(new_uri, self.credentials).tap do |_client|
+          _client.scoped_by_site = true
+        end
+      end
+    end
+
+    private
+
+    def domain
+      self.uri.to_s =~ /^https?:\/\/([^\/:]+)*/
+      $1
+    end
+
+  end
+
+end

data/lib/locomotive/coal/error.rb

@@ -0,0 +1,27 @@
+module Locomotive::Coal
+
+  # Take inspiration from this repository:
+  # https://github.com/vigeland/hooty
+  #
+  class Error < StandardError
+
+    def self.from_response(response)
+      status = response.code
+      if klass = case status
+                  when 401      then Locomotive::Coal::UnauthorizedError
+                  when 404      then Locomotive::Coal::UnknownResourceError
+                  when 429      then Locomotive::Coal::TooManyRequestsError
+                  when 400..499 then Error
+                  end
+        klass.new(response)
+      end
+    end
+  end
+
+  class MissingURIOrCredentialsError < Error; end
+  class UnknownResourceError < Error; end
+  class TooManyRequestsError < Error; end
+  class UnauthorizedError < Error; end
+  class BadRequestError < Error; end
+
+end

data/lib/locomotive/coal/paginated_resources.rb

@@ -0,0 +1,20 @@
+module Locomotive::Coal
+
+  class PaginatedResources < SimpleDelegator
+
+    attr_accessor :_page, :_total_pages, :_total_entries
+
+    def initialize(list, page, total_pages, total_entries)
+      @_page, @_total_pages, @_total_entries = page, total_pages, total_entries
+      super(list)
+    end
+
+    def _next_page
+      if @_page < @_total_pages
+        @_page + 1
+      end
+    end
+
+  end
+
+end

data/lib/locomotive/coal/request.rb

@@ -0,0 +1,63 @@
+module Locomotive::Coal
+
+  module Request
+
+    def get(endpoint, parameters = {}, raw = false)
+      safe_request_call(raw) do
+        Unirest.get   "#{uri.to_s}/#{endpoint}.json",
+          headers:    { 'Accept' => 'application/json' },
+          auth:       uri.userinfo,
+          parameters: parameters.merge(auth_token: token)
+      end
+    end
+
+    def post(endpoint, parameters = {})
+      parameters = parameters.merge(auth_token: token) if respond_to?(:token)
+
+      safe_request_call do
+        Unirest.post  "#{uri.to_s}/#{endpoint}.json",
+          auth:       uri.userinfo,
+          headers:    { 'Accept' => 'application/json' },
+          parameters: parameters
+      end
+    end
+
+    def put(endpoint, parameters = {})
+      parameters = parameters.merge(auth_token: token) if respond_to?(:token)
+
+      safe_request_call do
+        Unirest.put   "#{uri.to_s}/#{endpoint}.json",
+          auth:       uri.userinfo,
+          headers:    { 'Accept' => 'application/json' },
+          parameters: parameters
+      end
+    end
+
+    def delete(endpoint, id)
+      safe_request_call do
+        Unirest.delete    "#{uri.to_s}/#{endpoint}/#{id}.json",
+          auth:           uri.userinfo,
+          headers:        { 'Accept' => 'application/json' },
+          parameters:     { auth_token: token }
+      end
+    end
+
+    private
+
+    def safe_request_call(raw = false, &block)
+      response = begin
+        yield
+      rescue Exception => e
+        raise Locomotive::Coal::BadRequestError.new(e)
+      end
+
+      if response.code == 200
+        raw ? response : response.body
+      else
+        raise Locomotive::Coal::Error.from_response(response)
+      end
+    end
+
+  end
+
+end

data/lib/locomotive/coal/resource.rb

@@ -0,0 +1,21 @@
+module Locomotive::Coal
+
+  class Resource
+
+    attr_accessor :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def method_missing(name, *args)
+      if self.attributes.key?(name.to_s)
+        self.attributes[name.to_s]
+      else
+        super
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,35 @@
+module Locomotive::Coal
+
+  module Resources
+
+    class ContentEntries < Struct.new(:uri, :token, :content_type)
+
+      include Locomotive::Coal::Request
+
+      def all(query = {}, options = {})
+        parameters  = { where: query.to_json }.merge(options)
+        response    = get(endpoint, 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 update(id, attributes)
+        data = put(endpoint + "/#{id}", { content_entry: attributes })
+        Resource.new(data)
+      end
+
+      private
+
+      def endpoint(name = 'entries')
+        "content_types/#{content_type.slug}/#{name}"
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,25 @@
+module Locomotive::Coal
+  module Resources
+
+    class Contents < Struct.new(:uri, :token)
+
+      include Locomotive::Coal::Request
+
+      def by_slug(slug)
+        get('content_types').each do |attributes|
+          return Resource.new(attributes) if attributes['slug'] == slug.to_s
+        end
+      end
+
+      def method_missing(meth, *args)
+        if content_type = by_slug(meth)
+          Locomotive::Coal::Resources::ContentEntries.new(uri, token, content_type)
+        else
+          super
+        end
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+module Locomotive::Coal
+  module Resources
+
+    class MyAccount < Struct.new(:uri, :token)
+
+      include Locomotive::Coal::Request
+
+      def get
+        Resource.new(super('my_account'))
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,31 @@
+module Locomotive::Coal
+  module Resources
+
+    class Sites < Struct.new(:uri, :token)
+
+      include Locomotive::Coal::Request
+
+      def all
+        get('sites').map do |attributes|
+          Resource.new(attributes)
+        end
+      end
+
+      def create(attributes = {})
+        data = post('sites', { site: attributes })
+        Resource.new(data)
+      end
+
+      def by_subdomain(subdomain)
+        all.find { |site| site.subdomain == subdomain.to_s }
+      end
+
+      def destroy(id)
+        data = delete('sites', id)
+        Resource.new(data)
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+module Locomotive::Coal
+  module Resources
+
+    class Token < Struct.new(:uri, :credentials)
+
+      include Locomotive::Coal::Request
+
+      def get
+        post('tokens', self.credentials)['token']
+      end
+
+    end
+
+  end
+end

data/lib/locomotive/coal/version.rb

@@ -0,0 +1,8 @@
+# http://semver.org/
+# MAJOR.MINOR.PATCH format.
+# 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'
+  end
+end

data/lib/locomotive/coal.rb

@@ -0,0 +1,16 @@
+require 'active_support'
+require 'active_support/concern'
+require 'active_support/deprecation'
+require 'active_support/core_ext'
+require 'unirest'
+
+require_relative 'coal/error'
+require_relative 'coal/request'
+require_relative 'coal/paginated_resources'
+require_relative 'coal/resource'
+require_relative 'coal/resources/token'
+require_relative 'coal/resources/my_account'
+require_relative 'coal/resources/sites'
+require_relative 'coal/resources/contents'
+require_relative 'coal/resources/content_entries'
+require_relative 'coal/client'

data/locomotivecms_coal.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/locomotive/coal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'locomotivecms_coal'
+  spec.version       = Locomotive::Coal::VERSION
+  spec.authors       = ['Didier Lafforgue']
+  spec.email         = ['did@locomotivecms.com']
+  spec.description   = %q{The LocomotiveCMS coal is the API ruby client for LocomotiveCMS}
+  spec.summary       = %q{The LocomotiveCMS coal is the API ruby client for LocomotiveCMS}
+  spec.homepage      = 'http://www.locomotivecms.com'
+  spec.homepage      = 'https://github.com/locomotivecms/coal'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',    '~> 1.9.1'
+  spec.add_development_dependency 'rake',       '~> 10.4.2'
+
+  spec.add_dependency 'unirest',                '~> 1.1.2'
+  spec.add_dependency 'activesupport',          '~> 4.2.1'
+
+  spec.required_ruby_version = '>= 2.0'
+end