gather_content-api 1.0.0

data/spec/gather_content/api/item_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Item, vcr: true do
+  let(:item_id) { '123456' }
+  let(:item) { GatherContent::Api::Item.new(item_id) }
+
+  describe '.new' do
+    subject { item }
+
+    context 'when item ID is passed in' do
+      it { is_expected.to be_a GatherContent::Api::Item }
+    end
+
+    context 'when item ID is not passed in' do
+      let(:item_id) { nil }
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe '#fetch' do
+    subject { item.fetch }
+    it { is_expected.to be_a Hash }
+  end
+
+  describe "[]" do
+    subject { item }
+
+    it "returns the data related to the supplied key" do
+      expect(subject["id"]).to eq(123456)
+      expect(subject["project_id"]).to eq(123456)
+      expect(subject["parent_id"]).to eq(0)
+    end
+  end
+
+  describe "save" do
+    let(:config) { {} }
+    subject { item.save(config) }
+
+    context "successful" do
+      let(:config) {
+        [{
+          "label": "Content",
+          "name": "tab1",
+          "hidden": false,
+          "elements": [{
+              "type": "text",
+              "name": "el1",
+              "required": false,
+              "label": "Blog post",
+              "value": "Hello world",
+              "microcopy": "",
+              "limit_type": "words",
+              "limit": 1000,
+              "plain_text": false
+          }]
+        }]
+      }
+
+      it "returns true" do
+        expect(subject).to eq(true)
+      end
+    end
+
+    context "unsuccessful" do
+      it 'raises an RequestError' do
+        expect { subject }.to raise_error GatherContent::Error::RequestError
+      end
+
+      it 'sets the RequestError status' do
+        begin
+          subject
+        rescue GatherContent::Error::RequestError => e
+          expect(e.status).to eq(400)
+        end
+      end
+
+      it 'parses the message' do
+        begin
+          subject
+        rescue GatherContent::Error::RequestError => e
+          expect(e.message).to eq("Invalid config field")
+        end
+      end
+    end
+  end
+
+  describe "apply_template" do
+    subject { item.apply_template(template_id) }
+
+    context "successful" do
+      let(:template_id) { 1085780 }
+
+      it "returns true" do
+        expect(subject).to eq(true)
+      end
+    end
+
+    context "unsuccessful" do
+      let(:template_id) { 1085779 }
+      it 'raises an RequestError' do
+        expect { subject }.to raise_error GatherContent::Error::RequestError
+      end
+
+      it 'sets the RequestError status' do
+        begin
+          subject
+        rescue GatherContent::Error::RequestError => e
+          expect(e.status).to eq(500)
+        end
+      end
+
+      it 'parses the message' do
+        begin
+          subject
+        rescue GatherContent::Error::RequestError => e
+          expect(e.message).to eq("unknown error")
+        end
+      end
+    end
+  end
+
+  describe "choose_status" do
+    subject { item.choose_status(status_id) }
+
+    context "successful" do
+      let(:status_id) { 991221 }
+
+      it "returns true" do
+        expect(subject).to eq(true)
+      end
+    end
+
+    context "unsuccessful" do
+      let(:status_id) { 991219 }
+      it 'raises an RequestError' do
+        expect { subject }.to raise_error GatherContent::Error::RequestError
+      end
+
+      it 'sets the RequestError status' do
+        begin
+          subject
+        rescue GatherContent::Error::RequestError => e
+          expect(e.status).to eq(500)
+        end
+      end
+
+      it 'parses the message' do
+        begin
+          subject
+        rescue GatherContent::Error::RequestError => e
+          expect(e.message).to eq("unknown error")
+        end
+      end
+    end
+  end
+end

data/spec/gather_content/api/items_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Items, vcr: true do
+  let(:project_id) { '123456' }
+  let(:items) { GatherContent::Api::Items.new(project_id) }
+
+  describe '.new' do
+    subject { items }
+
+    context 'when project ID is passed in' do
+      it { is_expected.to be_a GatherContent::Api::Items }
+    end
+
+    context 'when project ID is not passed in' do
+      let(:project_id) { nil }
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe '#each' do
+    subject { items }
+
+    it { is_expected.to be_a Enumerable }
+
+    it 'should contain Item objects' do
+      subject.each do |item|
+        expect(item).to be_a GatherContent::Api::Item
+      end
+    end
+
+    it 'should have memoized data' do
+      expect(subject.first["id"]).to eq(123456)
+      expect(subject.first["project_id"]).to eq(123456)
+      expect(subject.first["parent_id"]).to eq(0)
+    end
+  end
+
+  describe "#create" do
+    let(:name) { "Test Item" }
+    let(:config) { nil }
+
+    subject { items.create({'name' => name, 'config' => config}) }
+
+    context 'with name' do
+      it "created an item" do
+        expect(subject).to be_a GatherContent::Api::Item
+      end
+
+      it "set the item id" do
+        expect(subject.item_id).to eq("6499285")
+      end
+    end
+
+    context 'with no name' do
+      let(:name) { nil }
+
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+
+    context 'with empty name' do
+      let(:name) { "" }
+
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+
+    context 'with config' do
+      let(:config) do
+        [{
+          "label": "Content",
+          "name": "tab1",
+          "hidden": false,
+          "elements": [{
+              "type": "text",
+              "name": "el1",
+              "required": false,
+              "label": "Blog post",
+              "value": "Hello world",
+              "microcopy": "",
+              "limit_type": "words",
+              "limit": 1000,
+              "plain_text": false
+          }]
+        }]
+      end
+
+      it "created an item" do
+        expect(subject).to be_a GatherContent::Api::Item
+      end
+
+      it "set the item id" do
+        expect(subject.item_id).to eq("6499285")
+      end
+
+      it "sets the content" do
+        expect(subject["config"]).to_not be_nil
+      end
+    end
+
+    context 'on non-202 response' do
+      it 'raises an RequestError' do
+        expect { subject }.to raise_error GatherContent::Error::RequestError
+      end
+
+      it 'sets the RequestError message' do
+        begin
+          subject
+        rescue GatherContent::Error::RequestError => e
+          expect(e.message).to eq("")
+        end
+      end
+
+      it 'sets the RequestError status' do
+        begin
+          subject
+        rescue GatherContent::Error::RequestError => e
+          expect(e.status).to eq(200)
+        end
+      end
+    end
+  end
+end

data/spec/gather_content/api/me_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Me, vcr: true do
+  let(:me) { GatherContent::Api::Me.new }
+
+  describe '.new' do
+    subject { me }
+
+    it { is_expected.to be_a GatherContent::Api::Me }
+  end
+
+  describe '#fetch' do
+    subject { me.fetch }
+    it { is_expected.to be_a Hash }
+  end
+
+  describe "[]" do
+    subject { me }
+
+    it "returns the data related to the supplied key" do
+      expect(subject["email"]).to eq("andrew@gathercontent.com")
+      expect(subject["first_name"]).to eq("Andrew")
+      expect(subject["last_name"]).to eq("Cairns")
+    end
+  end
+end

data/spec/gather_content/api/project_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Project, vcr: true do
+  let(:project_id) { 123456 }
+  let(:project) { GatherContent::Api::Project.new(project_id) }
+
+  describe '.new' do
+    subject { project }
+
+    it { is_expected.to be_a GatherContent::Api::Project }
+  end
+
+  describe '#get' do
+    subject { project.project_id }
+    it { is_expected.to eql project_id }
+  end
+
+  describe '#fetch' do
+    subject { project.fetch }
+    it { is_expected.to be_a Hash }
+  end
+
+  describe "[]" do
+    subject { project }
+
+    it "returns the data related to the supplied key" do
+      expect(subject["id"]).to eq(123456)
+      expect(subject["name"]).to eq("Example Project")
+      expect(subject["account_id"]).to eq(123456)
+    end
+  end
+end

data/spec/gather_content/api/projects_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Projects, vcr: true do
+  let(:account_id) { 123456 }
+  let(:projects) { GatherContent::Api::Projects.new(account_id) }
+
+  describe '#each' do
+    subject { projects }
+    it { is_expected.to be_a Enumerable }
+
+    it 'should contain Project objects' do
+      projects.each do |project|
+        expect(project).to be_a GatherContent::Api::Project
+      end
+    end
+  end
+
+  describe "#create" do
+    let(:name) { "Test Project" }
+    let(:type) { "website-build" }
+
+    subject { projects.create({'name' => name, 'type' => type}) }
+
+    context 'with name and valid type' do
+      it "created a project" do
+        expect(subject).to be_a GatherContent::Api::Project
+      end
+
+      it "set the project id" do
+        expect(subject.project_id).to eq("161823")
+      end
+    end
+
+    context 'with no name' do
+      let(:name) { nil }
+
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+
+    context 'with empty name' do
+      let(:name) { "" }
+
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+
+    context 'with no type' do
+      let(:type) { nil }
+
+      it "created a project" do
+        expect(subject).to be_a GatherContent::Api::Project
+      end
+    end
+
+    context 'with empty type' do
+      let(:type) { "" }
+
+      it "created a project" do
+        expect(subject).to be_a GatherContent::Api::Project
+      end
+    end
+
+    context 'with invalid type' do
+      let(:type) { "invalid" }
+
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+
+    context 'on non-202 response' do
+      it 'raises an RequestError' do
+        expect { subject }.to raise_error GatherContent::Error::RequestError
+      end
+
+      it 'sets the RequestError message' do
+        begin
+          subject
+        rescue GatherContent::Error::RequestError => e
+          expect(e.message).to eq("Account not found")
+        end
+      end
+
+      it 'sets the RequestError status' do
+        begin
+          subject
+        rescue GatherContent::Error::RequestError => e
+          expect(e.status).to eq(200)
+        end
+      end
+    end
+  end
+end

data/spec/gather_content/api/status_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Status, vcr: true do
+  let(:project_id) { 123456 }
+  let(:status_id) { 123456 }
+  let(:status) { GatherContent::Api::Status.new(project_id, status_id) }
+
+  describe '.new' do
+    subject { status }
+
+    context 'when project id and status is is passed in' do
+      it { is_expected.to be_a GatherContent::Api::Status }
+    end
+
+    context 'when project id is not passed in' do
+      let(:project_id) { nil }
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+
+    context 'when status id is not passed in' do
+      let(:status_id) { nil }
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe '#fetch' do
+    subject { status.fetch }
+    it { is_expected.to be_a Hash }
+  end
+
+  describe "[]" do
+    subject { status }
+
+    it "returns the data related to the supplied key" do
+      expect(subject["id"]).to eq("123456")
+      expect(subject["is_default"]).to eq(true)
+      expect(subject["position"]).to eq("1")
+    end
+  end
+end

data/spec/gather_content/api/statuses_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Statuses, vcr: true do
+  let(:project_id) { 123456 }
+  let(:statuses) { GatherContent::Api::Statuses.new(project_id) }
+
+  describe '.new' do
+    subject { statuses }
+
+    context 'when project id is passed in' do
+      it { is_expected.to be_a GatherContent::Api::Statuses }
+    end
+
+    context 'when project id is not passed in' do
+      let(:project_id) { nil }
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe '#each' do
+    subject { statuses }
+
+    it { is_expected.to be_a Enumerable }
+
+    it 'should contain Status objects' do
+      subject.each do |status|
+        expect(status).to be_a GatherContent::Api::Status
+      end
+    end
+
+    it 'should have memoized data' do
+      expect(subject.first["id"]).to eq("123456")
+      expect(subject.first["is_default"]).to eq(true)
+      expect(subject.first["position"]).to eq("1")
+    end
+  end
+end

data/spec/gather_content/api/template_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Template, vcr: true do
+  let(:template_id) { '123456' }
+  let(:template) { GatherContent::Api::Template.new(template_id) }
+
+  describe '.new' do
+    subject { template }
+
+    context 'when template ID is passed in' do
+      it { is_expected.to be_a GatherContent::Api::Template }
+    end
+
+    context 'when template ID is not passed in' do
+      let(:template_id) { nil }
+      it 'should raise an ArgumentError' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe '#fetch' do
+    subject { template.fetch }
+    it { is_expected.to be_a Hash }
+  end
+
+  describe "[]" do
+    subject { template }
+
+    it "returns the data related to the supplied key" do
+      expect(subject["id"]).to eq(123456)
+      expect(subject["project_id"]).to eq(123456)
+      expect(subject["name"]).to eq("Blog Theme")
+    end
+  end
+end

data/spec/gather_content/api/templates_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Templates, vcr: true do
+  let(:project_id) { 123456 }
+  let(:templates) { GatherContent::Api::Templates.new(project_id) }
+
+  describe '#each' do
+    subject { templates }
+    it { is_expected.to be_a Enumerable }
+
+    it 'should contain Template objects' do
+      templates.each do |template|
+        expect(template).to be_a GatherContent::Api::Template
+      end
+    end
+
+    it 'should have memoized data' do
+      expect(subject.first["id"]).to eq(123456)
+      expect(subject.first["project_id"]).to eq(123456)
+      expect(subject.first["name"]).to eq("Blog Theme")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'coveralls'
+Coveralls.wear!
+
+$: <<  "#{File.dirname(__FILE__)}/../lib"
+Dir['#{File.dirname(__FILE__)}/support/**/*.rb'].each {|f| require f}
+
+require 'pry'
+require 'vcr'
+require 'gather_content'
+require 'climate_control'
+# require 'figs'
+# Figs.load()
+
+VCR.configure do |c|
+  c.filter_sensitive_data('api-id') { GatherContent::Api::Config.instance.username }
+  c.filter_sensitive_data('api-key') { GatherContent::Api::Config.instance.api_key }
+  c.filter_sensitive_data('gather_content_api_host') { ENV['GATHER_CONTENT_API_HOST'] }
+  c.default_cassette_options = { record: :new_episodes, allow_playback_repeats: true }
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.configure_rspec_metadata!
+  c.hook_into :webmock
+end
+
+def with_modified_env(options, &block)
+  ClimateControl.modify(options, &block)
+end

data/spec/vcr_cassettes/GatherContent_Api_Account/_/returns_the_data_related_to_the_supplied_key.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.gathercontent.com/accounts/123456
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.14.0
+      Accept:
+      - application/vnd.gathercontent.v0.5+json
+      Authorization:
+      - Basic YW5kcmV3QGdhdGhlcmNvbnRlbnQuY29tOjJkMmE4YmY2LTA4YzAtNDllNi05NDYwLTI1MTM5ZmRiOGIyNA==
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 26 Feb 2018 04:08:03 GMT
+      Server:
+      - nginx
+      Content-Length:
+      - '75'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: '{"data":{"id":"123456","name":"Example","slug":"example","timezone":"UTC"}}'
+    http_version:
+  recorded_at: Mon, 26 Feb 2018 04:08:03 GMT

data/spec/vcr_cassettes/GatherContent_Api_Account/_fetch/1_2_1.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.gathercontent.com/accounts/123456
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.14.0
+      Accept:
+      - application/vnd.gathercontent.v0.5+json
+      Authorization:
+      - Basic YW5kcmV3QGdhdGhlcmNvbnRlbnQuY29tOjJkMmE4YmY2LTA4YzAtNDllNi05NDYwLTI1MTM5ZmRiOGIyNA==
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 26 Feb 2018 04:08:03 GMT
+      Server:
+      - nginx
+      Content-Length:
+      - '75'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: '{"data":{"id":"123456","name":"Example","slug":"example","timezone":"UTC"}}'
+    http_version:
+  recorded_at: Mon, 26 Feb 2018 04:08:03 GMT