locomotivecms_coal 1.0.0.pre.alpha

data/spec/integration/resources/sites_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Locomotive::Coal::Resources::Sites do
+
+  before { VCR.insert_cassette 'sites', record: :new_episodes }
+  after  { VCR.eject_cassette }
+
+  let(:uri)     { TEST_API_URI }
+  let(:token)   { api_token }
+  let(:sites)   { described_class.new(uri, token) }
+
+  describe '#all' do
+
+    subject { sites.all }
+    it { expect(subject.size).to be > 0 }
+
+    describe 'first site' do
+      subject { sites.all.first }
+      it { expect(subject.name).not_to eq nil }
+    end
+  end
+
+  describe '#create' do
+    subject { create_site }
+    it { expect(subject._id).not_to eq nil }
+  end
+
+  describe '#by_subdomain' do
+    subject { sites.by_subdomain('sample') }
+    it { expect(subject._id).not_to eq nil }
+  end
+
+  describe '#destroy' do
+    let(:new_site) { sites.by_subdomain('acme') || create_site }
+    subject { sites.destroy(new_site._id) }
+    it { expect(subject._id).to eq nil }
+  end
+
+  def create_site
+    sites.create(name: 'Acme', subdomain: 'acme', locales: ['en'])
+  end
+
+end

data/spec/integration/resources/token_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Locomotive::Coal::Resources::Token do
+
+  before { VCR.insert_cassette 'token', record: :new_episodes }
+  after  { VCR.eject_cassette }
+
+  let(:uri)         { nil }
+  let(:credentials) { nil }
+  let(:token)       { described_class.new(uri, credentials) }
+
+  describe '#get' do
+
+    subject { token.get }
+
+    context 'uri not pointing to a Locomotive engine' do
+        let(:uri) { URI('http://www.example.com:4000') }
+        let(:credentials) { { email: 'john@doe.net', password: 'easyone' } }
+        it { expect { subject }.to raise_error Locomotive::Coal::UnknownResourceError }
+      end
+
+    context 'valid uri' do
+      let(:uri) { TEST_API_URI }
+
+      context 'email + password as credentials' do
+        let(:credentials) { { email: 'john@doe.net', password: 'easyone' } }
+        it { is_expected.to match(/^[a-zA-Z0-9]{,20}$/) }
+      end
+
+      context 'api key as credentials' do
+        let(:credentials) { { email: 'john@doe.net', api_key: 'a9ac1e08c2c22c1b6f3da6db77a70cac4a615bd7' } }
+        it { is_expected.to match(/^[a-zA-Z0-9]{,20}$/) }
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+require 'simplecov'
+require 'codeclimate-test-reporter'
+require 'coveralls'
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    CodeClimate::TestReporter::Formatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  add_filter 'spec/'
+  add_filter 'lib/locomotive/coal/version.rb'
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'webmock/rspec'
+require 'vcr'
+
+# VCR config
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/coal_cassettes'
+  c.hook_into :webmock
+  c.ignore_hosts 'codeclimate.com'
+  c.configure_rspec_metadata!
+end
+
+require_relative 'support/default_resources'
+require_relative 'support/api_settings'
+require_relative 'support/pry'
+
+require_relative '../lib/locomotive/coal'
+
+RSpec.configure do |config|
+  # config.include Spec::Helpers
+
+  # config.filter_run focused: true
+  # config.run_all_when_everything_filtered = true
+
+  # config.before { reset! }
+  # config.after  { reset! }
+
+  config.order = :random
+end

data/spec/support/api_settings.rb

@@ -0,0 +1,6 @@
+TEST_API_URI          = URI('http://sample.lvh.me:4000/locomotive/api').freeze
+TEST_API_CREDENTIALS  = { email: 'john@doe.net', password: 'easyone' }.freeze
+
+def api_token(uri = nil, credentials = nil)
+  Locomotive::Coal::Resources::Token.new(uri || TEST_API_URI, credentials || TEST_API_CREDENTIALS.dup).get
+end

data/spec/support/default_resources.rb

@@ -0,0 +1,7 @@
+# def create_acme_site(sites)
+#   sites.create(name: 'Acme', subdomain: 'acme', locales: ['en'])
+# end
+
+# def reset_acme_site(sites)
+#   sites.destroy()
+# end

data/spec/support/pry.rb

@@ -0,0 +1,4 @@
+begin
+  require 'pry'
+rescue LoadError
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Locomotive::Coal::Client do
+
+  let(:uri)         { nil }
+  let(:credentials) { nil }
+  let(:client)      { described_class.new(uri, credentials) }
+
+  describe '#initialize' do
+
+    subject { client }
+
+    context 'no uri' do
+      let(:credentials) { { email: 'fake' } }
+      it { expect { subject }.to raise_error Locomotive::Coal::MissingURIOrCredentialsError }
+    end
+
+    context 'no credentials' do
+      let(:uri) { 'http://sample.lvh.me:4000/locomotive/api' }
+      it { expect { subject }.to raise_error Locomotive::Coal::MissingURIOrCredentialsError }
+    end
+
+  end
+
+end

data/spec/unit/paginated_resources_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Locomotive::Coal::PaginatedResources do
+
+  let(:list)          { ['a', 42, :foo] }
+  let(:page)          { 1 }
+  let(:total_pages)   { 1 }
+  let(:total_entries) { 3 }
+  let(:paginate)      { described_class.new(list, page, total_pages, total_entries) }
+
+  describe '#find' do
+    subject { paginate.find { |el| el == 42 } }
+    it { is_expected.to eq 42 }
+  end
+
+  describe '#each' do
+    it { expect(paginate.respond_to?(:each)).to eq true }
+  end
+
+  describe '#_next_page' do
+    subject { paginate._next_page }
+    it { is_expected.to eq nil }
+
+    context '3 pages of entries' do
+      let(:total_pages) { 3 }
+      it { is_expected.to eq 2 }
+
+      context 'current page is the last one' do
+        let(:page) { 3 }
+        it { is_expected.to eq nil }
+      end
+    end
+  end
+
+  describe '#_page' do
+    subject { paginate._page }
+    it { is_expected.to eq 1 }
+  end
+
+  describe '#_total_pages' do
+    subject { paginate._total_pages }
+    it { is_expected.to eq 1 }
+  end
+
+  describe '#_total_entries' do
+    subject { paginate._total_entries }
+    it { is_expected.to eq 3 }
+  end
+
+end

data/spec/unit/resource_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Locomotive::Coal::Resource do
+
+  let(:attributes)  { { 'title' => 'Hello world' } }
+  let(:resource)    { described_class.new(attributes) }
+
+  describe 'unknown attribute' do
+    subject { resource.name }
+    it { expect { subject }.to raise_error }
+  end
+
+  describe 'existing attribute' do
+    subject { resource.title }
+    it { is_expected.to eq 'Hello world' }
+  end
+
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: locomotivecms_coal
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha
+platform: ruby
+authors:
+- Didier Lafforgue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+description: The LocomotiveCMS coal is the API ruby client for LocomotiveCMS
+email:
+- did@locomotivecms.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/locomotive/coal.rb
+- lib/locomotive/coal/client.rb
+- lib/locomotive/coal/error.rb
+- lib/locomotive/coal/paginated_resources.rb
+- lib/locomotive/coal/request.rb
+- lib/locomotive/coal/resource.rb
+- lib/locomotive/coal/resources/content_entries.rb
+- lib/locomotive/coal/resources/contents.rb
+- lib/locomotive/coal/resources/my_account.rb
+- lib/locomotive/coal/resources/sites.rb
+- lib/locomotive/coal/resources/token.rb
+- lib/locomotive/coal/version.rb
+- locomotivecms_coal.gemspec
+- spec/fixtures/coal_cassettes/client.yml
+- spec/fixtures/coal_cassettes/content_entries.yml
+- spec/fixtures/coal_cassettes/contents.yml
+- spec/fixtures/coal_cassettes/my_account.yml
+- spec/fixtures/coal_cassettes/sites.yml
+- spec/fixtures/coal_cassettes/token.yml
+- spec/integration/client_spec.rb
+- spec/integration/resources/content_entries_spec.rb
+- spec/integration/resources/contents_spec.rb
+- spec/integration/resources/my_account_spec.rb
+- spec/integration/resources/sites_spec.rb
+- spec/integration/resources/token_spec.rb
+- spec/spec_helper.rb
+- spec/support/api_settings.rb
+- spec/support/default_resources.rb
+- spec/support/pry.rb
+- spec/unit/client_spec.rb
+- spec/unit/paginated_resources_spec.rb
+- spec/unit/resource_spec.rb
+homepage: https://github.com/locomotivecms/coal
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: The LocomotiveCMS coal is the API ruby client for LocomotiveCMS
+test_files:
+- spec/fixtures/coal_cassettes/client.yml
+- spec/fixtures/coal_cassettes/content_entries.yml
+- spec/fixtures/coal_cassettes/contents.yml
+- spec/fixtures/coal_cassettes/my_account.yml
+- spec/fixtures/coal_cassettes/sites.yml
+- spec/fixtures/coal_cassettes/token.yml
+- spec/integration/client_spec.rb
+- spec/integration/resources/content_entries_spec.rb
+- spec/integration/resources/contents_spec.rb
+- spec/integration/resources/my_account_spec.rb
+- spec/integration/resources/sites_spec.rb
+- spec/integration/resources/token_spec.rb
+- spec/spec_helper.rb
+- spec/support/api_settings.rb
+- spec/support/default_resources.rb
+- spec/support/pry.rb
+- spec/unit/client_spec.rb
+- spec/unit/paginated_resources_spec.rb
+- spec/unit/resource_spec.rb