marble_api_client 1.0.0.pre.alpha

data/lib/marble_api_client/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  VERSION = '1.0.0-alpha'
+end

data/lib/marble_api_client.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'net/http'
+
+require_relative 'marble_api_client/proxy'
+require_relative 'marble_api_client/requests'
+require_relative 'marble_api_client/responses'
+
+# This class interacts with Blue Marble Payroll Webglobe API
+module MarbleApiClient
+end

data/marble_api_client.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require './lib/marble_api_client/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'marble_api_client'
+  s.version     = MarbleApiClient::VERSION
+  s.summary     = 'Write a summary.'
+
+  s.description = <<-DESCRIPTION
+    Write a description.
+  DESCRIPTION
+
+  s.authors     = ['Dan Dewar']
+  s.email       = ['ddewar@bluemarblepayroll.com']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.homepage    = 'https://github.com/bluemarblepayroll/marble_api_client'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('rake', '~> 12')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rubocop', '~>0.74.0')
+  s.add_development_dependency('simplecov', '~>0.17.0')
+  s.add_development_dependency('simplecov-console', '~>0.5.0')
+  s.add_development_dependency('webmock')
+end

data/spec/marble_api_client/proxy_spec.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe MarbleApiClient::Proxy do
+  let(:proxy) do
+    MarbleApiClient::Proxy.new(
+      'http://www.example.com:3000',
+      headers: { 'Content-Type': 'application/json' }
+    )
+  end
+
+  it 'requires a base_url' do
+    expect { MarbleApiClient::Proxy.new(nil) }
+      .to raise_error(ArgumentError, 'Base URL is not valid')
+  end
+
+  it 'uses SSL for HTTPS requests' do
+    p = MarbleApiClient::Proxy.new(
+      'https://www.example.com:3000',
+      headers: { 'Content-Type': 'application/json' }
+    )
+
+    stub_request(:post, 'https://www.example.com:3000/custom/path/create')
+    p.create('custom/path')
+    expect(WebMock).to have_requested(:post, 'https://www.example.com:3000/custom/path/create')
+  end
+
+  context 'create' do
+    it 'sends requests to path' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/create')
+      proxy.create('custom/path')
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
+    end
+
+    it 'sends requests to path ending in "/"' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/create')
+      proxy.create('custom/path/')
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
+    end
+
+    it 'sends correct headers' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/create')
+      proxy.create('custom/path', headers: { option: 'val' })
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
+        .with(headers: { 'Content-Type': 'application/json',
+                         option: 'val' })
+    end
+
+    it 'sends the correct body' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/create')
+      proxy.create('custom/path',
+                   create_request: MarbleApiClient::Requests::Create.new(record: { name: 'blue' }))
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
+        .with(body: { context: {}, record: { name: 'blue' } })
+    end
+  end
+
+  context 'index' do
+    it 'sends to requested path' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/index')
+      proxy.index('custom/path')
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/index')
+    end
+
+    it 'sends the correct headers' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/index')
+      proxy.index('custom/path', headers: { option: 'val' })
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/index')
+        .with(headers: { 'Content-Type': 'application/json',
+                         option: 'val' })
+    end
+
+    it 'sends the correct body' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/index')
+      proxy.index('custom/path',
+                  index_request: MarbleApiClient::Requests::Index.new(record: { name: 'blue' }))
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/index')
+        .with(body: { context: {}, record: { name: 'blue' }, page: 1, page_size: 25 })
+    end
+  end
+end

data/spec/marble_api_client/requests/create_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe MarbleApiClient::Requests::Create do
+  it 'builds the body' do
+    request = MarbleApiClient::Requests::Create.new(
+      context: { red: 'blue' },
+      record: { green: 'yellow' }
+    )
+
+    expected = {
+      context: {
+        red: 'blue'
+      },
+      record: {
+        green: 'yellow'
+      }
+    }.to_json
+
+    expect(request.request_body).to eq(expected)
+  end
+end

data/spec/marble_api_client/requests/index_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe MarbleApiClient::Requests::Index do
+  it 'builds the body' do
+    request = MarbleApiClient::Requests::Index.new(
+      context: { red: 'blue' },
+      record: { green: 'yellow' },
+      page: 123,
+      page_size: 10
+    )
+
+    expected = {
+      context: {
+        red: 'blue'
+      },
+      record: {
+        green: 'yellow'
+      },
+      page: 123,
+      page_size: 10
+    }.to_json
+
+    expect(request.request_body).to eq(expected)
+  end
+end

data/spec/marble_api_client/responses/bad_request_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe MarbleApiClient::Responses::BadRequest do
+  context 'provides' do
+    let(:error_hash) { { name: 'invalid' }.to_json }
+    let(:response) do
+      instance_double(Net::HTTPResponse, code: 400, body: { errors: error_hash }.to_json)
+    end
+
+    it 'errors' do
+      expect(described_class.new(response).errors)
+        .to eq(error_hash)
+    end
+  end
+end

data/spec/marble_api_client/responses/client_error_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe MarbleApiClient::Responses::ClientError do
+  let(:error_hash) { { name: 'invalid' }.to_json }
+  let(:response) do
+    instance_double(Net::HTTPResponse, code: 400, body: { errors: error_hash }.to_json)
+  end
+
+  it 'has access to response code' do
+    expect(described_class.new(response).code).to eq(400)
+  end
+end

data/spec/marble_api_client/responses/forbidden_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe MarbleApiClient::Responses::Forbidden do
+  context 'provides' do
+    let(:response) do
+      instance_double(Net::HTTPResponse,
+                      code: 400,
+                      body: { statusCode: '403',
+                              redirectUrl: 'www.example.com/hello' }.to_json)
+    end
+
+    it 'Status Code' do
+      expect(described_class.new(response).status_code)
+        .to eq('403')
+    end
+
+    it 'Redirect URL' do
+      expect(described_class.new(response).redirect_url)
+        .to eq('www.example.com/hello')
+    end
+  end
+end

data/spec/marble_api_client/responses/list_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe MarbleApiClient::Responses::List do
+  context 'provides' do
+    let(:page) { '7' }
+    let(:page_size) { '12' }
+    let(:meta) { { grid_color: 'blue' }.to_json }
+    let(:records) { [{ name: 'record_1' }, { name: 'record_2' }].to_json }
+    let(:sort_direction) { 'ASC' }
+    let(:sort_column_index) { '3' }
+    let(:total) { '120' }
+    let(:total_pages) { '10' }
+    let(:response) do
+      instance_double(Net::HTTPResponse,
+                      code: 400,
+                      body: {
+                        page: page,
+                        pageSize: page_size,
+                        meta: meta,
+                        records: records,
+                        sortDirection: sort_direction,
+                        sortColumnIndex: sort_column_index,
+                        total: total,
+                        totalPages: total_pages
+                      }.to_json)
+    end
+
+    it 'page' do
+      expect(described_class.new(response).page)
+        .to eq(page)
+    end
+
+    it 'page_size' do
+      expect(described_class.new(response).page_size)
+        .to eq(page_size)
+    end
+
+    it 'meta' do
+      expect(described_class.new(response).meta)
+        .to eq(meta)
+    end
+
+    it 'records' do
+      expect(described_class.new(response).records)
+        .to eq(records)
+    end
+
+    it 'sort driection' do
+      expect(described_class.new(response).sort_direction)
+        .to eq(sort_direction)
+    end
+
+    it 'sort column index' do
+      expect(described_class.new(response).sort_column_index)
+        .to eq(sort_column_index)
+    end
+
+    it 'total' do
+      expect(described_class.new(response).total)
+        .to eq(total)
+    end
+
+    it 'total pages' do
+      expect(described_class.new(response).total_pages)
+        .to eq(total_pages)
+    end
+  end
+end

data/spec/marble_api_client/responses/not_found_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe MarbleApiClient::Responses::NotFound do
+  context 'provides' do
+    let(:error_hash) { { name: 'invalid' }.to_json }
+    let(:response) do
+      instance_double(Net::HTTPResponse, code: 400, body: { errors: error_hash }.to_json)
+    end
+
+    it 'errors' do
+      expect(described_class.new(response).errors)
+        .to eq(error_hash)
+    end
+  end
+end

data/spec/marble_api_client/responses/not_implmented_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe MarbleApiClient::Responses::NotImplemented do
+  context 'provides' do
+    let(:error_hash) { { name: 'invalid' }.to_json }
+    let(:response) do
+      instance_double(Net::HTTPResponse, code: 400, body: { errors: error_hash }.to_json)
+    end
+
+    it 'errors' do
+      expect(described_class.new(response).errors)
+        .to eq(error_hash)
+    end
+  end
+end

data/spec/marble_api_client/responses/record_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe MarbleApiClient::Responses::Record do
+  context 'provides' do
+    let(:record) { { name: 'record_1' }.to_json }
+    let(:response) do
+      instance_double(Net::HTTPResponse, code: 400, body: { record: record }.to_json)
+    end
+
+    it 'errors' do
+      expect(described_class.new(response).record)
+        .to eq(record)
+    end
+  end
+end