gather_content-api 1.0.0

data/lib/gather_content/api/item.rb

@@ -0,0 +1,53 @@
+require "base64"
+
+module GatherContent
+  module Api
+    class Item < Base
+      attr_accessor :item_id
+
+      def initialize(item_id, data = nil)
+        raise ArgumentError, "Item_id is required!" if item_id.nil?
+        @item_id = item_id
+        @data = data
+      end
+
+      def [](key)
+        fetch[key]
+      end
+
+      def save(config)
+        encoded = Base64.strict_encode64(config.to_json)
+        result = post_json({config: encoded}, "#{path}/save")
+        if result.status == 202
+          true
+        else
+          raise GatherContent::Error::RequestError.new(result)
+        end
+      end
+
+      def apply_template(template_id)
+        post_save({ "template_id" => template_id }, "#{path}/apply_template")
+      end
+
+      def choose_status(status_id)
+        post_save({ "status_id" => status_id }, "#{path}/choose_status")
+      end
+
+    private
+      def post_save(params, path)
+        result = post_json(params, path)
+        if result.status == 202
+          true
+        else
+          raise GatherContent::Error::RequestError.new(result)
+        end
+      end
+
+      def path
+        @path ||= "/items/#{item_id}"
+      end
+
+      def params; end
+    end
+  end
+end

data/lib/gather_content/api/items.rb

@@ -0,0 +1,50 @@
+require "base64"
+
+module GatherContent
+  module Api
+    class Items < Base
+      include Enumerable
+      attr_accessor :project_id
+
+      def initialize(project_id)
+        raise ArgumentError, "Project_id is required!" if project_id.nil?
+        @project_id = project_id
+      end
+
+      def each(&block)
+        fetch.each do |item|
+          yield GatherContent::Api::Item.new(item['id'], item)
+        end
+      end
+
+      def create(data)
+        data.delete("parent_id") if data["parent_id"].nil? || data["parent_id"].empty?
+        data.delete("template_id") if data["template_id"].nil? || data["template_id"].empty?
+
+        config = data.delete("config")
+        data["config"] = Base64.strict_encode64(config.to_json) unless config.nil? || config.empty?
+
+        raise ArgumentError, "name is required!" if data["name"].nil? || data["name"].empty?
+
+        result = post_json(data.merge({ 'project_id' => @project_id }))
+
+        if result.status == 202
+          item_id = result.headers['location'].split('/').last
+          GatherContent::Api::Item.new(item_id)
+        else
+          raise GatherContent::Error::RequestError.new(result)
+        end
+      end
+
+    private
+      def params
+        { project_id: project_id }
+      end
+
+      def path
+        @path ||= '/items'
+      end
+
+    end
+  end
+end

data/lib/gather_content/api/me.rb

@@ -0,0 +1,19 @@
+module GatherContent
+  module Api
+    class Me < Base
+      def initialize; end
+
+      def [](key)
+        fetch[key]
+      end
+
+    private
+
+      def path
+        @path ||= "/me"
+      end
+
+      def params; end
+    end
+  end
+end

data/lib/gather_content/api/project.rb

@@ -0,0 +1,25 @@
+module GatherContent
+  module Api
+    class Project < Base
+      attr_accessor :project_id
+
+      def initialize(project_id, data = nil)
+        raise ArgumentError, "project_id is required!" if project_id.nil?
+        @project_id = project_id
+        @data = data
+      end
+
+      def [](key)
+        fetch[key]
+      end
+
+    private
+
+      def path
+        @path ||= "/projects/#{project_id}"
+      end
+
+      def params; end
+    end
+  end
+end

data/lib/gather_content/api/projects.rb

@@ -0,0 +1,51 @@
+module GatherContent
+  module Api
+    class Projects < Base
+      attr_accessor :account_id
+      include Enumerable
+
+      def initialize(account_id)
+        raise ArgumentError, "account_id is required!" if account_id.nil?
+        @account_id = account_id
+      end
+
+      def each(&block)
+        fetch.each do |project|
+          yield GatherContent::Api::Project.new(project['id'], project)
+        end
+      end
+
+      def create(data)
+        data.delete("type") if data["type"].nil? || data["type"].empty?
+
+        raise ArgumentError, "name is required!" if data["name"].nil? || data["name"].empty?
+        raise ArgumentError, "type is invalid!" unless valid_type?(data["type"])
+
+        result = post_json(data.merge({ 'account_id' => @account_id }))
+
+        if result.status == 202
+          project_id = result.headers['location'].split('/').last
+          GatherContent::Api::Project.new(project_id)
+        else
+          raise GatherContent::Error::RequestError.new(result)
+        end
+      end
+
+    private
+
+      def params
+        { account_id: @account_id }
+      end
+
+      def path
+        @path ||= '/projects'
+      end
+
+      def valid_type?(type)
+        return type = "other" if type.nil? || type.empty?
+        types = %w{website-build ongoing-website-content marketing-editorial-content email-marketing-content other}
+        types.include?(type)
+      end
+    end
+  end
+end

data/lib/gather_content/api/status.rb

@@ -0,0 +1,26 @@
+module GatherContent
+  module Api
+    class Status < Base
+      attr_accessor :project_id, :status_id
+
+      def initialize(project_id, status_id, data = nil)
+        raise ArgumentError, "project_id is required!" if project_id.nil?
+        raise ArgumentError, "status_id is required!" if status_id.nil?
+        @project_id = project_id
+        @status_id = status_id
+        @data = data
+      end
+
+      def [](key)
+        fetch[key]
+      end
+
+    private
+      def path
+        @path ||= "/projects/#{project_id}/statuses/#{status_id}"
+      end
+
+      def params; end
+    end
+  end
+end

data/lib/gather_content/api/statuses.rb

@@ -0,0 +1,27 @@
+module GatherContent
+  module Api
+
+    class Statuses < Base
+      attr_accessor :project_id
+      include Enumerable
+
+      def initialize(project_id)
+        raise ArgumentError, "project_id is required!" if project_id.nil?
+        @project_id = project_id
+      end
+
+      def each(&block)
+        fetch.each do |status|
+          yield GatherContent::Api::Status.new(@project_id, status['id'], status)
+        end
+      end
+
+    private
+      def path
+        @path ||= "/projects/#{project_id}/statuses"
+      end
+
+      def params; end
+    end
+  end
+end

data/lib/gather_content/api/template.rb

@@ -0,0 +1,25 @@
+module GatherContent
+  module Api
+    class Template < Base
+      attr_accessor :template_id
+
+      def initialize(template_id, data = nil)
+        raise ArgumentError, "Template_id is required!" if template_id.nil?
+        @template_id = template_id
+        @data = data
+      end
+
+      def [](key)
+        fetch[key]
+      end
+
+    private
+
+      def path
+        @path ||= "/templates/#{template_id}"
+      end
+
+      def params; end
+    end
+  end
+end

data/lib/gather_content/api/templates.rb

@@ -0,0 +1,35 @@
+module GatherContent
+  module Api
+    class Templates < Base
+      attr_accessor :project_id
+      include Enumerable
+
+      def initialize(project_id)
+        raise ArgumentError, "project_id is required!" if project_id.nil?
+        @project_id = project_id
+      end
+
+      def each(&block)
+        fetch.each do |template|
+          yield GatherContent::Api::Template.new(template['id'], template)
+        end
+      end
+
+    private
+
+      def params
+        { project_id: @project_id }
+      end
+
+      def path
+        @path ||= '/templates'
+      end
+
+      def valid_type?(type)
+        return type = "other" if type.nil? || type.empty?
+        types = %w{website-build ongoing-website-content marketing-editorial-content email-marketing-content other}
+        types.include?(type)
+      end
+    end
+  end
+end

data/lib/gather_content/api.rb

@@ -0,0 +1,19 @@
+module GatherContent
+  module Api
+    autoload :Config, 'gather_content/api/config'
+    autoload :Base, 'gather_content/api/base'
+    autoload :Me, 'gather_content/api/me'
+    autoload :Accounts, 'gather_content/api/accounts'
+    autoload :Account, 'gather_content/api/account'
+    autoload :Projects, 'gather_content/api/projects'
+    autoload :Project, 'gather_content/api/project'
+    autoload :Items, 'gather_content/api/items'
+    autoload :Item, 'gather_content/api/item'
+    autoload :Statuses, 'gather_content/api/statuses'
+    autoload :Status, 'gather_content/api/status'
+    autoload :Files, 'gather_content/api/files'
+    autoload :File, 'gather_content/api/file'
+    autoload :Templates, 'gather_content/api/templates'
+    autoload :Template, 'gather_content/api/template'
+  end
+end

data/lib/gather_content/error/request_error.rb

@@ -0,0 +1,33 @@
+module GatherContent
+  module Error
+    class RequestError < StandardError
+      attr_reader :response, :status
+
+      def initialize(response)
+        @response = response
+        @status = response.status
+
+        super(parse_message(response))
+      end
+
+    private
+      def parse_message(response)
+        parsed = JSON.parse(response.body)
+
+        return response.body unless parsed.is_a?(Hash)
+        return parsed['data'].join(' ') if parsed['data'].is_a?(Array)
+
+        if parsed.is_a?(Hash) && parsed['data']
+          data = parsed['data']
+
+          return data['message'] if data['message']
+          return data.to_s
+        elsif parsed.is_a?(Hash) && parsed['error']
+          parsed['error']
+        else
+          parsed['data'].to_s
+        end
+      end
+    end
+  end
+end

data/lib/gather_content/error.rb

@@ -0,0 +1,5 @@
+module GatherContent
+  module Error
+    autoload :RequestError, 'gather_content/error/request_error'
+  end
+end

data/lib/gather_content/version.rb

@@ -0,0 +1,3 @@
+module GatherContent
+  VERSION = "1.0.0"
+end

data/lib/gather_content.rb

@@ -0,0 +1,5 @@
+require 'json'
+require 'faraday'
+require 'gather_content/version'
+require 'gather_content/api'
+require 'gather_content/error'

data/spec/gather_content/api/account_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Account, vcr: true do
+  let(:account_id) { 123456 }
+  let(:account) { GatherContent::Api::Account.new(account_id) }
+
+  describe '.new' do
+    subject { account }
+
+    it { is_expected.to be_a GatherContent::Api::Account }
+  end
+
+  describe '#fetch' do
+    subject { account.fetch }
+    it { is_expected.to be_a Hash }
+  end
+
+  describe "[]" do
+    subject { account }
+
+    it "returns the data related to the supplied key" do
+      expect(subject["id"]).to eq("123456")
+      expect(subject["name"]).to eq("Example")
+      expect(subject["slug"]).to eq("example")
+      expect(subject["timezone"]).to eq("UTC")
+    end
+  end
+end

data/spec/gather_content/api/accounts_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Accounts, vcr: true do
+  let(:accounts) { GatherContent::Api::Accounts.new }
+
+  describe '#each' do
+    subject { accounts }
+
+    it { is_expected.to be_a Enumerable }
+
+    it 'should contain Account objects' do
+      subject.each do |account|
+        expect(account).to be_a GatherContent::Api::Account
+      end
+    end
+
+    it 'should have memoized data' do
+      expect(subject.first["id"]).to eq("123456")
+      expect(subject.first["name"]).to eq("Example")
+      expect(subject.first["slug"]).to eq("example")
+      expect(subject.first["timezone"]).to eq("UTC")
+    end
+  end
+end

data/spec/gather_content/api/base_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Base do
+
+end

data/spec/gather_content/api/config_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'climate_control'
+
+describe GatherContent::Api::Config do
+  subject { GatherContent::Api::Config.instance }
+
+  let(:username) { "default" }
+  let(:api_key) { "a2d8b22c-25cc-4f45-8892-2298ccf70f47" }
+  let(:host) { nil }
+  let(:port) { nil }
+
+  around do |example|
+    env = {
+      GATHER_CONTENT_API_USERNAME: username,
+      GATHER_CONTENT_API_KEY: api_key,
+      GATHER_CONTENT_API_HOST: host,
+      GATHER_CONTENT_API_PORT: port
+    }
+    ClimateControl.modify env do
+      example.run
+    end
+  end
+
+  describe '#default' do
+    it "uses the value from GATHER_CONTENT_API_USERNAME" do
+      expect(subject.username).to eq(username)
+    end
+
+    it "uses the value from GATHER_CONTENT_API_KEY" do
+      expect(subject.api_key).to eq(api_key)
+    end
+
+    describe "with GATHER_CONTENT_API_HOST" do
+      let(:host) { "https://env.gathercontent.com" }
+
+      it "uses the value from GATHER_CONTENT_API_HOST" do
+        expect(subject.host).to eq(host)
+      end
+    end
+
+    describe "without GATHER_CONTENT_API_HOST" do
+      it "uses https://api.gathercontent.com" do
+        expect(subject.host).to eq("https://api.gathercontent.com")
+      end
+    end
+
+    describe "with GATHER_CONTENT_API_PORT" do
+      let(:port) { "1443" }
+
+      it "uses the value from GATHER_CONTENT_API_PORT" do
+        expect(subject.port).to eq(port)
+      end
+    end
+
+    describe "without GATHER_CONTENT_API_PORT" do
+      it "uses 443" do
+        expect(subject.port).to eq("443")
+      end
+    end
+  end
+
+  describe '#run' do
+    let(:username) { "example" }
+    let(:api_key) { "baa89326-f1be-4959-93e5-effb204e5a6f" }
+    let(:host) { "https://specialhost.gathercontent.com" }
+    let(:port) { "8443" }
+
+    before(:each) do
+      GatherContent::Api::Config.run do |config|
+        config.username = username
+        config.api_key = api_key
+      end
+    end
+
+    after(:each) do
+      GatherContent::Api::Config.run do |config|
+        config.username = nil
+        config.api_key = nil
+      end
+    end
+
+    it "stores the username" do
+      expect(subject.username).to eq(username)
+    end
+
+    it "stores the api_key" do
+      expect(subject.api_key).to eq(api_key)
+    end
+
+    it "stores the host" do
+      expect(subject.host).to eq(host)
+    end
+
+    it "stores the port" do
+      expect(subject.port).to eq(port)
+    end
+  end
+end

data/spec/gather_content/api/files_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe GatherContent::Api::Files, vcr: true do
+  let(:item_id) { 123456 }
+  let(:files) { GatherContent::Api::Files.new(item_id) }
+
+  describe '.new' do
+    subject { files }
+
+    context 'when project id is passed in' do
+      it { is_expected.to be_a GatherContent::Api::Files }
+    end
+
+    context 'when project 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 '#each' do
+    subject { files }
+
+    it { is_expected.to be_a Enumerable }
+
+    it 'should contain File objects' do
+      subject.each do |file|
+        expect(file).to be_a GatherContent::Api::File
+      end
+    end
+
+    it 'should have memoized data' do
+      expect(subject.first["id"]).to eq(1)
+      expect(subject.first["user_id"]).to eq(1)
+      expect(subject.first["item_id"]).to eq(123456)
+    end
+  end
+end