tripletexer 0.1.2 → 0.2.0

data/lib/tripletexer/endpoints/ledger/close_group.rb

@@ -5,8 +5,8 @@ module Tripletexer::Endpoints
     # https://tripletex.no/v2-docs/#!/ledger47closeGroup/search
     def search(date_from, date_to, params = {})
       final_params = params.merge(
-        'dateFrom' => format_date(date_from),
-        'dateTo' => format_date(date_to)
+        'dateFrom' => ::Tripletexer::FormatHelpers.format_date(date_from),
+        'dateTo' => ::Tripletexer::FormatHelpers.format_date(date_to)
       )
       find_entities('/v2/ledger/closeGroup', final_params)
     end

data/lib/tripletexer/endpoints/ledger/posting.rb

@@ -6,8 +6,8 @@ module Tripletexer::Endpoints
     # https://tripletex.no/v2-docs/#!/ledger47posting/search
     def search(date_from, date_to, params = {})
       final_params = params.merge(
-        'dateFrom' => format_date(date_from),
-        'dateTo' => format_date(date_to)
+        'dateFrom' => ::Tripletexer::FormatHelpers.format_date(date_from),
+        'dateTo' => ::Tripletexer::FormatHelpers.format_date(date_to)
       )
       find_entities('/v2/ledger/posting', final_params)
     end

data/lib/tripletexer/endpoints/ledger/voucher.rb

@@ -6,8 +6,8 @@ module Tripletexer::Endpoints
     # https://tripletex.no/v2-docs/#!/ledger47voucher/search
     def search(date_from, date_to, params = {})
       final_params = params.merge(
-        'invoiceDateFrom' => format_date(date_from),
-        'invoiceDateTo' => format_date(date_to)
+        'invoiceDateFrom' => ::Tripletexer::FormatHelpers.format_date(date_from),
+        'invoiceDateTo' => ::Tripletexer::FormatHelpers.format_date(date_to)
       )
       find_entities('/v2/ledger/voucher', final_params)
     end

data/lib/tripletexer/endpoints/order.rb

@@ -6,8 +6,8 @@ module Tripletexer::Endpoints
     # https://tripletex.no/v2-docs/#!/order/search
     def search(date_from, date_to, params = {})
       final_params = params.merge(
-        'orderDateFrom' => format_date(date_from),
-        'orderDateTo' => format_date(date_to)
+        'orderDateFrom' => ::Tripletexer::FormatHelpers.format_date(date_from),
+        'orderDateTo' => ::Tripletexer::FormatHelpers.format_date(date_to)
       )
       find_entities('/v2/order', final_params)
     end
@@ -30,14 +30,14 @@ module Tripletexer::Endpoints
     # https://tripletex.no/v2-docs/#!/order/invoice
     def create_invoice(id, invoice_date, send_to_customer = true)
       final_params = params.merge(
-        'invoiceDate' => format_date(invoice_date),
+        'invoiceDate' => ::Tripletexer::FormatHelpers.format_date(invoice_date),
         'sendToCustomer' => send_to_customer.to_s
       )
-      put("/v2/order/#{id}", final_params)
+      api_client.put("/v2/order/#{id}", final_params)
     end
 
     def orderline
-      ::Tripletexer::Endpoints::Order::Orderline.new(connection)
+      ::Tripletexer::Endpoints::Order::Orderline.new(api_client)
     end
   end
 end

data/lib/tripletexer/endpoints/project.rb

@@ -19,7 +19,7 @@ module Tripletexer::Endpoints
     end
 
     def category
-      Tripletexer::Endpoints::Project::Category.new(connection)
+      Tripletexer::Endpoints::Project::Category.new(api_client)
     end
 
   end

data/lib/tripletexer/endpoints/timesheet.rb

@@ -3,11 +3,11 @@
 module Tripletexer::Endpoints
   class Timesheet < AbstractEndpoint
     def entry
-      Tripletexer::Endpoints::Timesheet::Entry.new(connection)
+      Tripletexer::Endpoints::Timesheet::Entry.new(api_client)
     end
 
     def time_clock
-      Tripletexer::Endpoints::Timesheet::TimeClock.new(connection)
+      Tripletexer::Endpoints::Timesheet::TimeClock.new(api_client)
     end
   end
 end

data/lib/tripletexer/endpoints/timesheet/entry.rb

@@ -6,8 +6,8 @@ module Tripletexer::Endpoints
     # https://tripletex.no/v2-docs/#!/timesheet47entry/search
     def search(from_date, to_date, params = {})
       final_params = params.merge(
-        'dateFrom' => format_date(from_date),
-        'dateTo' => format_date(to_date)
+        'dateFrom' => ::Tripletexer::FormatHelpers.format_date(from_date),
+        'dateTo' => ::Tripletexer::FormatHelpers.format_date(to_date)
       )
       find_entities('/v2/timesheet/entry', final_params)
     end

data/lib/tripletexer/endpoints/timesheet/time_clock.rb

@@ -13,7 +13,7 @@ module Tripletexer::Endpoints
       final_params = params.merge(
         'activityId' => activity_id
       )
-      put('/timesheet/timeClock/:start', final_params)
+      api_client.put('/timesheet/timeClock/:start', final_params)
     end
 
     # https://tripletex.no/v2-docs/#!/timesheet47timeClock/getPresent
@@ -33,7 +33,7 @@ module Tripletexer::Endpoints
 
     # https://tripletex.no/v2-docs/#!/timesheet47timeClock/stop
     def stop(id, params = {})
-      put("/timesheet/timeClock/#{id}/:stop", params)
+      api_client.put("/timesheet/timeClock/#{id}/:stop", params)
     end
   end
 end

data/lib/tripletexer/endpoints/token.rb

@@ -3,11 +3,11 @@
 module Tripletexer::Endpoints
   class Token < AbstractEndpoint
     def consumer
-      ::Tripletexer::Endpoints::Token::Consumer.new(connection)
+      ::Tripletexer::Endpoints::Token::Consumer.new(api_client)
     end
 
     def session
-      ::Tripletexer::Endpoints::Token::Session.new(connection)
+      ::Tripletexer::Endpoints::Token::Session.new(api_client)
     end
   end
 end

data/lib/tripletexer/endpoints/token/session.rb

@@ -6,15 +6,15 @@ module Tripletexer::Endpoints
 
     # https://tripletex.no/v2-docs/#!/token47session/create
     def create(consumer_token, employee_token, expiration_date: Time.now.utc + DAY_IN_SECONDS)
-      response = put('/v2/token/session/:create') do |req|
+      response = api_client.put('/v2/token/session/:create') do |req|
         req.params = {
           'consumerToken' => consumer_token,
           'employeeToken' => employee_token,
-          'expirationDate' => format_date(expiration_date)
+          'expirationDate' => ::Tripletexer::FormatHelpers.format_date(expiration_date)
         }
       end
-      connection.token = response.dig('value', 'token')
-      response
+      api_client.session_token = response['value']['token']
+      response['value']
     end
 
     # https://tripletex.no/v2-docs/#!/token47session/whoAmI
@@ -23,9 +23,9 @@ module Tripletexer::Endpoints
     end
 
     # https://tripletex.no/v2-docs/#!/token47session/delete
-    def destroy(token = connection.token)
-      response = delete("/v2/token/session/#{token}")
-      connection.reset
+    def destroy(session_token = api_client.session_token)
+      response = api_client.delete("/v2/token/session/#{session_token}")
+      api_client.reset_connection
       response
     end
   end

data/lib/tripletexer/format_helpers.rb

@@ -1,12 +1,15 @@
 module Tripletexer::FormatHelpers
-  def format_date(value)
-    return value if value.is_a? String
-    value.to_date.to_s
+  def self.format_date(value)
+    return nil if value.nil?
+    return value.to_date.to_s if value.respond_to?(:to_date)
+    raise TypeError, 'value must be Date, Time or String' unless value.is_a?(String)
+    return value if value =~ /\A\d{4}-[01]\d-[0-3]\d\z/
+    raise ArgumentError, 'invalid date format, must be YYYY-MM-DD'
   end
 
-  def normalize_body(body)
+  def self.normalize_body(body)
     return body if body.is_a?(String)
     return JSON.dump(body) if body.is_a?(Hash) || body.is_a?(Array)
-    raise ArtumentError, 'unsupported body type'
+    raise ArgumentError, 'unsupported body type'
   end
 end

data/lib/tripletexer/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 class Tripletexer
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
   API_VERSION = '2.1.2'
 end

data/spec/client_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Tripletexer::APIClient do
+  describe '#connection' do
+    it 'returns new Faraday connection' do
+      expect( subject.connection ).to be_an_instance_of Faraday::Connection
+    end
+
+    context "when #session_token isn't set" do
+      it 'returns new connection every time' do
+        subject.session_token = nil
+        expect( subject.connection.object_id ).to_not eq subject.connection.object_id
+      end
+    end
+
+    context 'when #session_token is set' do
+      it 'reuses connection' do
+        subject.session_token = 'token'
+        expect( subject.connection.object_id ).to eq subject.connection.object_id
+      end
+    end
+  end
+
+  describe '#reset_connection' do
+    before do
+      subject.session_token = 'token'
+      subject.connection
+    end
+
+    it 'destroys session_token' do
+      expect { subject.reset_connection }.to change { subject.session_token }.to(nil)
+    end
+
+    it 'destroys cached connection' do
+      expect { subject.reset_connection }.to change { subject.connection.object_id }
+    end
+  end
+
+  describe '#session_token=' do
+    before do
+      subject.session_token = 'token'
+      subject.connection
+    end
+
+    it 'destroys cached connection' do
+      expect { subject.session_token = 'new_token' }.to change { subject.connection.object_id }
+    end
+
+    it 'changes session token to given token' do
+      expect { subject.session_token = 'new_token' }.to change { subject.session_token }.to('new_token')
+    end
+  end
+
+end

data/spec/endpoints/order_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'web_helper'
+
+RSpec.describe Tripletexer::Endpoints::Order do
+  subject { Tripletexer.new(session_token: ENV['SESSION_TOKEN']).order }
+
+  describe '#search' do
+    it 'returns enumerator', vcr: 'endpoints/order/search' do
+      response = subject.search(Date.new(2017), Date.new(2018, 9, 26))
+      expect( response ).to be_an_instance_of Enumerator
+    end
+
+    it 'returns two orders', vcr: 'endpoints/order/search' do
+      response = subject.search(Date.new(2017), Date.new(2018, 9, 26)).to_a
+      expect( response.size ).to eq 2
+      expect( response[0]['id'] ).to eq 23432678
+    end
+  end
+
+  describe '#create' do
+    it 'has no test yet'
+  end
+
+  describe '#find' do
+    it 'returns order with given id', vcr: 'endpoints/order/find' do
+      response = subject.find(23432678)
+      expect( response ).to include('id' => 23432678)
+    end
+
+    it 'raises Tripletexer::Errors::Unauthorized when user has no access to order', vcr: 'endpoints/order/find__unauthorized' do
+      expect { subject.find(23432677) }.to raise_error Tripletexer::Errors::Unauthorized
+    end
+  end
+
+  describe '#update' do
+    it 'has no test yet'
+  end
+
+  describe '#create_invoice' do
+    it 'has no test yet'
+  end
+
+  describe 'orderline' do
+    it 'returns order/orderline endpoint' do
+      expect( subject.orderline ).to be_an_instance_of ::Tripletexer::Endpoints::Order::Orderline
+    end
+  end
+
+end

data/spec/endpoints/timesheet_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Tripletexer::Endpoints::Timesheet do
+  subject { Tripletexer.new.timesheet }
+
+  describe "#entry" do
+    it 'returns token/consumer endpoint' do
+      expect( subject.entry ).to be_an_instance_of ::Tripletexer::Endpoints::Timesheet::Entry
+    end
+  end
+
+  describe "#time_clock" do
+    it 'returns token/time_clock endpoint' do
+      expect( subject.time_clock ).to be_an_instance_of ::Tripletexer::Endpoints::Timesheet::TimeClock
+    end
+  end
+end

data/spec/endpoints/token/session_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'web_helper'
+
+RSpec.describe Tripletexer::Endpoints::Token::Session do
+
+  describe '#create' do
+    subject { Tripletexer.new.token.session }
+    it 'creates new session and sets session_token for connection', vcr: 'endpoints/token/session/create' do
+      response = subject.create(ENV['CONSUMER_SECRET'], ENV['EMPLOYEE_TOKEN'])
+      expect( subject.send(:api_client).session_token ).to eq response['token']
+    end
+  end
+
+  describe '#whoami' do
+    subject { Tripletexer.new(session_token: ENV['SESSION_TOKEN']).token.session }
+
+    it 'returns info about session', vcr: 'endpoints/token/session/whoami' do
+      expect( subject.whoami ).to eq("employeeId" => 1133333, "companyId" => 3795625)
+    end
+  end
+
+  describe '#destroy' do
+    subject { Tripletexer.new.token.session }
+    it 'destroys session', vcr: 'endpoints/token/session/destroy' do
+      expect { subject.whoami }.to raise_error ::Tripletexer::Errors::Unauthorized
+      subject.create(ENV['CONSUMER_SECRET'], ENV['EMPLOYEE_TOKEN'])
+      expect { subject.whoami }.to_not raise_error
+      expect( subject.destroy ).to eq ''
+      expect { subject.whoami }.to raise_error ::Tripletexer::Errors::Unauthorized
+    end
+  end
+end

data/spec/endpoints/token_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Tripletexer::Endpoints::Token do
+  subject { Tripletexer.new.token }
+
+  describe "#consumer" do
+    it 'returns token/consumer endpoint' do
+      expect( subject.consumer ).to be_an_instance_of ::Tripletexer::Endpoints::Token::Consumer
+    end
+  end
+
+  describe "#session" do
+    it 'returns token/session endpoint' do
+      expect( subject.session ).to be_an_instance_of ::Tripletexer::Endpoints::Token::Session
+    end
+  end
+end

data/spec/format_helpers_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'date'
+
+RSpec.describe Tripletexer::FormatHelpers do
+  subject { described_class }
+
+  describe '.format_date' do
+    it 'returns nil when given nil' do
+      expect( subject.format_date(nil) ).to be_nil
+    end
+
+    it 'returns date string when given date' do
+      expect( subject.format_date(Date.new(2016, 5, 1)) ).to eq '2016-05-01'
+    end
+
+    it 'returns date string when given time' do
+      expect( subject.format_date(Time.new(2013, 5, 4, 12, 12, 15)) ).to eq '2013-05-04'
+    end
+
+    it 'raises TypeError when given unsupported object' do
+      expect { subject.format_date({}) }.to raise_error(TypeError, 'value must be Date, Time or String')
+    end
+
+    it 'returns date string when given date string' do
+      expect( subject.format_date('2018-07-09') ).to eq '2018-07-09'
+    end
+
+    it "raises ArgumentError when given string doesn't look valid" do
+      expect { subject.format_date('foo') }.to raise_error(ArgumentError, 'invalid date format, must be YYYY-MM-DD')
+      expect { subject.format_date('2017-99-99') }.to raise_error(ArgumentError, 'invalid date format, must be YYYY-MM-DD')
+    end
+  end
+
+  describe '.normalize_body' do
+    it 'returns given string' do
+      expect( subject.normalize_body('test') ).to eq 'test'
+    end
+
+    it 'returns JSON string of given hash' do
+      expect( subject.normalize_body({foo: :bar}) ).to eq '{"foo":"bar"}'
+    end
+
+    it 'returns JSON string of given array' do
+      expect( subject.normalize_body(['foo', 1, 'bar']) ).to eq '["foo",1,"bar"]'
+    end
+
+    it 'raises ArgumentError when different object is given' do
+      expect { subject.normalize_body(1) }.to raise_error(ArgumentError, 'unsupported body type')
+      expect { subject.normalize_body(:foo) }.to raise_error(ArgumentError, 'unsupported body type')
+      expect { subject.normalize_body(Object.new) }.to raise_error(ArgumentError, 'unsupported body type')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter %r{^/spec/}
+  add_group 'Endpoints', 'lib/tripletexer/endpoints'
+end
+require 'dotenv/load'
+require 'tripletexer'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end