sls_adf 0.0.1

data/spec/lib/query_spec.rb

@@ -0,0 +1,61 @@
+RSpec.describe SlsAdf::Query do
+  let!(:stub) do
+    stub_request(:post, SlsAdf.configuration.graphql_url).
+      to_return(status: 200, body: JSON.dump('data' => response_hash))
+  end
+
+  describe '.context' do
+    let(:uuid) { SecureRandom.uuid }
+    let(:response_hash) { { 'context' => {} } }
+    subject { SlsAdf::Query.context(uuid) }
+
+    it 'makes a http request' do
+      subject
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '.user' do
+    let(:id) { 'random-id' }
+    let(:response_hash) { { 'user' => {} } }
+    subject { SlsAdf::Query.user(id) }
+
+    it 'makes a http request' do
+      subject
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '.subject_group' do
+    let(:uuid) { SecureRandom.uuid }
+    let(:response_hash) { { 'subjectGroup' => {} } }
+    subject { SlsAdf::Query.subject_group(uuid) }
+
+    it 'makes a http request' do
+      subject
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '.assignment' do
+    let(:uuid) { SecureRandom.uuid }
+    let(:response_hash) { { 'assignment' => {} } }
+    subject { SlsAdf::Query.subject_group(uuid) }
+
+    it 'makes a http request' do
+      subject
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '.task' do
+    let(:uuid) { SecureRandom.uuid }
+    let(:response_hash) { { 'task' => {} } }
+    subject { SlsAdf::Query.subject_group(uuid) }
+
+    it 'makes a http request' do
+      subject
+      expect(stub).to have_been_requested
+    end
+  end
+end

data/spec/lib/sls_adf_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe SlsAdf do
+  it "has a version number" do
+    expect(SlsAdf::VERSION).not_to be nil
+  end
+end

data/spec/lib/util/adapter_spec.rb

@@ -0,0 +1,96 @@
+RSpec.describe SlsAdf::Util::Adapter do
+  let(:adapter) { SlsAdf::Util::Adapter.new }
+  describe '.execute' do
+    let(:document) do
+      GraphQL.parse(<<-'GRAPHQL')
+        query getCharacter($id: ID!) {
+          character(id: $id) {
+            name
+          }
+        }
+      GRAPHQL
+    end
+    let(:operation_name) { 'getCharacter' }
+    let(:variables) { { 'id' => '1001' } }
+    subject do
+      adapter.execute(
+        document: document, operation_name: operation_name, variables: variables
+      )
+    end
+
+    context 'when response is successful' do
+      let!(:stub) do
+        stub_request(:post, SlsAdf.configuration.graphql_url).
+          to_return(status: 200, body: JSON.dump(response))
+      end
+      let(:response) do
+        { 'data' => { 'character' => { 'name' => 'Darth Vader' } } }
+      end
+
+      it { is_expected.to include(response) }
+      it { is_expected.to include(http_status: 200) }
+    end
+
+    context 'when request is sent' do
+      let!(:stub) do
+        stub_request(:post, SlsAdf.configuration.graphql_url).
+          with(headers: request_headers, body: JSON.dump(request_body)).
+          to_return(status: 200, body: JSON.dump('data' => 'foo'))
+      end
+      let(:request_headers) do
+        {
+          'Accept' => 'application/json',
+          'Content-Type' => 'application/json',
+          'Authorization' => 'Bearer ' + SlsAdf::CLIENT_TOKEN
+        }
+      end
+      let(:request_body) do
+        {
+          'query' => document.to_query_string,
+          'operationName' => operation_name,
+          'variables' => variables
+        }
+      end
+
+      it 'constructs the correct request headers and body' do
+        subject
+        expect(stub).to have_been_requested
+      end
+
+      context 'when the first response is unauthorised' do
+        let!(:stub) do
+          stub_request(:post, SlsAdf.configuration.graphql_url).
+            with(headers: request_headers, body: JSON.dump(request_body)).
+            to_return(
+              { status: 401, body: JSON.dump('errors' => 'wrong token') },
+              { status: 200, body: JSON.dump('data' => 'correct') }
+            )
+        end
+
+        it 'makes the same call after refreshing the token' do
+          subject
+          expect(stub).to have_been_requested.twice
+        end
+      end
+    end
+
+    context 'when the request times out' do
+      let!(:stub) { stub_request(:post, SlsAdf.configuration.graphql_url).to_timeout }
+
+      it 'returns an error response' do
+        expect(subject).to have_key(:errors)
+      end
+    end
+
+    context 'when the response is malformed' do
+      let!(:stub) do
+        stub_request(:post, SlsAdf.configuration.graphql_url).
+          to_return(status: 200, body: 'wrong')
+      end
+
+      it 'returns an error response' do
+        expect(subject).to have_key(:errors)
+      end
+    end
+  end
+end

data/spec/lib/util/token_spec.rb

@@ -0,0 +1,95 @@
+RSpec.describe SlsAdf::Util::Token do
+  def expected_response_body
+    JSON.dump(data: { token: SlsAdf::CLIENT_TOKEN })
+  end
+
+  def expected_request_body
+    { 'clientId' => SlsAdf.configuration.client_id,
+      'clientSecret' => SlsAdf.configuration.client_secret,
+      'grantType' => 'client_credentials',
+      'scope' => 'all' }
+  end
+
+  describe '.token' do
+    let!(:stub) do
+      stub_request(:post, SlsAdf.configuration.get_token_url).
+        to_return(status: 200, body: expected_response_body)
+    end
+    subject { SlsAdf::Util::Token.token }
+
+    it 'returns the correct token' do
+      expect(subject).to eq SlsAdf::CLIENT_TOKEN
+      expect(stub).to have_been_requested
+    end
+
+    context 'when token has been pre-loaded' do
+      before { subject }
+      it 'does not make another API call to load the token' do
+        # Clears stub and request history
+        WebMock.reset!
+        # Subject is not used as it doesn't invoke the actual object's method again.
+        SlsAdf::Util::Token.token
+        expect(a_request(:any, SlsAdf.configuration.get_token_url)).
+          not_to have_been_made
+      end
+    end
+  end
+
+  describe '.refresh_token' do
+    let!(:stub) do
+      stub_request(:post, SlsAdf.configuration.get_token_url).
+        to_return(status: http_response_code, body: expected_response_body)
+    end
+    let(:http_response_code) { 200 }
+    subject { SlsAdf::Util::Token.refresh_token }
+
+    it 'returns the correct token' do
+      expect(subject).to eq SlsAdf::CLIENT_TOKEN
+      expect(stub).to have_been_requested
+    end
+
+    it 'makes the right API call to the get token url' do
+      stub =
+        stub_request(:post, SlsAdf.configuration.get_token_url).
+          with(
+            headers: { 'Content-Type' => 'application/json' },
+            body: expected_request_body
+          ).
+          to_return(status: 200, body: expected_response_body)
+      subject
+      expect(stub).to have_been_requested
+    end
+
+    context 'when token has been preloaded' do
+      before { subject }
+      it 'makes another API call to load the token' do
+        # Clears stub and request history
+        WebMock.reset!
+
+        new_stub = stub_request(:post, SlsAdf.configuration.get_token_url).
+                     to_return(status: 200, body: expected_response_body)
+        # Subject is not used as it doesn't invoke the actual object's method again.
+        SlsAdf::Util::Token.refresh_token
+        expect(new_stub).to have_been_requested
+      end
+    end
+
+    context 'when API response is malformed' do
+      let!(:stub) do
+        stub_request(:post, SlsAdf.configuration.get_token_url).
+          to_return(status: 200, body: '400 Error')
+      end
+
+      it 'returns an empty string as the token' do
+        expect(subject).to eq('')
+      end
+    end
+
+    context 'when API response does not have http status code 200' do
+      let(:http_response_code) { 400 }
+      it 'returns an empty string as the token' do
+        expect(subject).to eq('')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'coverage_helper'
+
+require 'bundler/setup'
+require 'webmock/rspec'
+require 'sls_adf'
+
+# Load all files within the support folder
+Dir[__dir__ + '/support/**/*'].each { |f| require f if File.file?(f) }
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/configuration_helper.rb

@@ -0,0 +1,13 @@
+# Defines the method to initialise gem configuration for testing.
+module SlsAdf
+  def self.initialise_sls_adf_gem!
+    SlsAdf.configure do |c|
+      c.graphql_url = 'https://p0nmxpxpx0.lp.gql.zone/graphql'
+      c.get_token_url = 'https://example.com/token'
+      c.client_id = 'test_client_id'
+      c.client_secret = 'test_client_secret'
+    end
+  end
+end
+
+SlsAdf.initialise_sls_adf_gem!

data/spec/support/token_helper.rb

@@ -0,0 +1,24 @@
+# This helper initialises the stubbed version of the Token.
+module SlsAdf
+  CLIENT_TOKEN = 'some_token'.freeze
+
+  module Util
+    class StubbedToken
+      class << self
+        def token
+          SlsAdf::CLIENT_TOKEN
+        end
+
+        def refresh_token
+          SlsAdf::CLIENT_TOKEN
+        end
+      end
+    end
+
+    class Adapter
+      def token
+        @token ||= StubbedToken
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: sls_adf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Toh Weiqing
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client library for SLS's Application Development Framework (in progress).
+email:
+- hello@estl.moe
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".env.example"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sls_adf.rb
+- lib/sls_adf/base.rb
+- lib/sls_adf/configuration.rb
+- lib/sls_adf/mutation.rb
+- lib/sls_adf/query.rb
+- lib/sls_adf/schema/schema.json
+- lib/sls_adf/template.rb
+- lib/sls_adf/template/fragment.rb
+- lib/sls_adf/template/mutation.rb
+- lib/sls_adf/template/query.rb
+- lib/sls_adf/util.rb
+- lib/sls_adf/util/adapter.rb
+- lib/sls_adf/util/token.rb
+- lib/sls_adf/version.rb
+- sls_adf.gemspec
+- spec/coverage_helper.rb
+- spec/lib/base_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/mutation_spec.rb
+- spec/lib/query_spec.rb
+- spec/lib/sls_adf_spec.rb
+- spec/lib/util/adapter_spec.rb
+- spec/lib/util/token_spec.rb
+- spec/spec_helper.rb
+- spec/support/configuration_helper.rb
+- spec/support/token_helper.rb
+homepage: https://github.com/moexmen/sls-adf
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby client library for SLS (in progress).
+test_files: []