lws 6.1.0.beta4 → 6.1.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b58d4f19b39cd31f8eb39c19252248889bbcdc1
-  data.tar.gz: fe5430ca9566e47fce0585eb7dc5e9f3e06d1406
+  metadata.gz: 1572c59ecae295dace557e5554bbc20aa1a3d48e
+  data.tar.gz: 7ad14b5a843814bec826628a8a76a1c36827a389
 SHA512:
-  metadata.gz: a9b8964fe328533bd15bcc54aaa2e9f44239bafd204f00b56fbfc9e8ecc0050fecf14a1d6c4363f432d06074267e80689f4f40465ffa5be8ffdd8040a355cc39
-  data.tar.gz: 4f8664f672916043a6aac86cb7175f7e001c4df14537e0b2c345bd6f03306610184519afe7dc5ab5ca4f309eee8aca62c3f6a55b068f6c465e46b9063fde0009
+  metadata.gz: 8c18b43430a42d12ab04b42af7bd32ad4081e694aabc73206ffc20a4c7dcbafe1ed0377056500345cd142ea8be5691d1dc75b2a28a05ae148257d8adf7874863
+  data.tar.gz: b9b647419cbab122f209c8efada301d3e14aede20ce3a14cfa784b5138569b8421d29a0a31966338bc045c47c6a93bbbdb5f8fd6ce9d0bfdc5d336455b6f242b

data/bin/lwsconsole

@@ -82,7 +82,7 @@ begin
     puts "#{PROG_NAME}: Cannot find app `#{@options[:app]}', ignoring it!" unless @app_module
   end
 rescue => e
-  puts "#{PROG_NAME}: Problem during LWS setup: #{e}"
+  puts "#{PROG_NAME}: Problem during LWS setup: #{e} (#{e.class})"
   exit 3
 end
 

data/lib/lws/apps/auth.rb

@@ -299,6 +299,7 @@ module LWS::Auth
   # It cannot be accessed directly.
   class Device < LWS::Generic::Model
     use_api LWS::Auth.api
+    uri "accounts/:account_id/devices/(:id)"
 
     # @!attribute id [r]
     #   @return [Fixnum] the (unique) ID of the device
@@ -497,6 +498,7 @@ module LWS::Auth
   # It cannot be accessed directly.
   class User < LWS::Generic::Model
     use_api LWS::Auth.api
+    uri "accounts/:account_id/users/(:id)"
 
     # @!attribute id [r]
     #   @return [Fixnum] the (unique) ID of the user

data/lib/lws/apps/generic.rb

@@ -20,6 +20,25 @@ module LWS::Generic
   class Model < Spyke::Base
     include_root_in_json true
 
+    # @private
+    # @!visibility private
+    #
+    # This method wraps Spyke's .find method so that we can raise
+    # an LWS-specific exception.
+    #
+    # @param [Fixnum, String] id the ID of the resource to find and
+    #   retrieve
+    # @raise [LWS::Errors::ResourceNotFound] if not all of the resources
+    #   could be found
+    # @return [LWS::Generic::Model] the found resource
+    def self.find(id)
+      super
+    rescue Spyke::ResourceNotFound => exception
+      msg = "resource not found at " +
+        "URI #{self.uri} where :#{primary_key} is #{id.inspect}"
+      raise LWS::Errors::ResourceNotFound, msg
+    end
+
     # @private
     # @!visibility private
     #

data/lib/lws/apps/ticket.rb

@@ -158,7 +158,9 @@ module LWS::Ticket
     attribute :message
 
     # @!attribute status
-    #   @return [Fixnum] the new ticket status (ID) set by the message
+    #   @return ["success", "open", "closed", "in_progress", 'solved",
+    #     "feedback", "priority", "reassign"] the new ticket status set by
+    #     the message
     attribute :status
 
     # @!attribute ticket
@@ -293,11 +295,12 @@ module LWS::Ticket
     attribute :owner_id
 
     # @!attribute priority
-    #   @return [Fixnum] the priority (ID) of the ticket
+    #   @return ["low", "medium", "high"] the priority of the ticket
     attribute :priority
 
     # @!attribute status
-    #   @return [Fixnum] the current ticket status (ID)
+    #   @return ["success", "open", "closed", "in_progress", 'solved",
+    #     "feedback", "priority", "reassign"] the current ticket status
     attribute :status
 
     # @!attribute tags

data/lib/lws/errors.rb

@@ -0,0 +1,31 @@
+#
+# Copyright © 2016 LeftClick B.V.
+#
+# This software is property of LeftClick B.V. and cannot be redistributed
+# and/or modified without permission.  The software or any of its parts
+# cannot be used for any other purposes than the LeftClick services and
+# only during a valid license subscription.  For more information, please
+# contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
+# Netherlands, info@leftclick.eu, +31492-782120.
+
+
+module LWS
+
+  # = The errors module
+  #
+  # This module contains the exceptions that can be thrown.
+  module Errors
+    # Exception thrown if there are issues with the LWS configuration.
+    class ConfigError < StandardError; end
+
+    # Exception thrown if an invalid response is returned by LWS.
+    class InvalidResponse < StandardError; end
+
+    # Exception thrown if the resource could not be found in LWS.
+    class ResourceNotFound < StandardError; end
+
+    # Exception thrown if there is an issue with the stubbing setup.
+    class StubError < StandardError; end
+  end
+
+end

data/lib/lws/middleware/http_logger.rb

@@ -18,7 +18,10 @@ module LWS
     class HTTPLogger < Faraday::Response::Middleware
 
       def initialize(app, logger, show_headers)
-        raise "cannot log HTTP requests without a logger" if logger.nil?
+        if logger.nil?
+          raise LWS::Errors::ConfigError,
+            "cannot log HTTP requests without a logger"
+        end
         @logger = logger
         @show_headers = show_headers
         super(app)

data/lib/lws/middleware/json_logger.rb

@@ -18,7 +18,10 @@ module LWS
     class JSONLogger < Faraday::Response::Middleware
 
       def initialize(app, logger)
-        raise "cannot log JSON data without a logger" if logger.nil?
+        if logger.nil?
+          raise LWS::Errors::ConfigError,
+            "cannot log JSON data without a logger"
+        end
         @logger = logger
         super(app)
       end

data/lib/lws/middleware/json_parser.rb

@@ -28,6 +28,8 @@ module LWS
         { data: data,
           metadata: metadata,
           errors: errors }
+      rescue => exception
+        raise LWS::Errors::InvalidResponse, exception.message
       end
 
       def on_complete(env)

data/lib/lws/stubbing.rb

@@ -41,13 +41,19 @@ module LWS
     # exists.
     #
     # @param stubs_dir [Pathname, String] path to the directory with the fixtures.
+    # @raise [LWS::Errors::ConfigError] if the fixtures/stubs directory does
+    #   not exist
+    # @return [void]
     def initialize(stubs_dir)
       # Set up WebMock
       WebMock.enable!
       @stubs = {}
 
       # Load the fixtures
-      raise "not a valid stubs directory" unless File.directory? stubs_dir
+      unless File.directory? stubs_dir
+        raise LWS::Errors::ConfigError,
+          "not a valid stubs directory: #{stubs_dir}"
+      end
       @fixtures = {}
       Dir["#{stubs_dir}/**/*.yml"].each do |yml_file|
         yml = YAML.load_file(yml_file)
@@ -92,8 +98,8 @@ module LWS
     # @param fixture_name [Symbol, nil] the name of the fixture to use as stub
     #   response body (or +nil+ for an empty fixture)
     # @param http_status [Fixnum] the HTTP status code to use
-    # @raise if the fixture name could not be found for the given app name
-    #   and path
+    # @raise [LWS::Errors::StubError] if the fixture name could not be
+    #   found for the given app name and path
     # @return [void]
     def replace(method, app_name, path, fixture_name = :default, http_status = 200)
       fixture = if fixture_name
@@ -101,7 +107,10 @@ module LWS
                 else
                   {}
                 end
-      raise "fixture #{fixture_name} not found (app: #{app_name}, URI: #{path})" unless fixture
+      unless fixture
+        raise LWS::Errors::StubError,
+          "fixture #{fixture_name} not found (app: #{app_name}, URI: #{path})"
+      end
       app_module = LWS.app_module(app_name)
       app_endpoint_uri = app_module.api.url_prefix.dup
       app_endpoint_uri.path = path
@@ -127,12 +136,14 @@ module LWS
     # @param method [Symbol] the HTTP method (+:get+, +:put+, etc.)
     # @param app_name [Symbol] the app name (see {::SUPPORTED_APPS})
     # @param path [String] the path part of the request URI
-    # @raise if there is not request stub for the given HTTP method,
-    #   app name and path
+    # @raise [LWS::Errors::StubError] if there is not request stub for the
+    #   given HTTP method, app name and path
     # @return [void]
     def remove(method, app_name, path)
       request_stub = @stubs.delete([method, app_name, path])
-      raise "no such request stub" unless request_stub
+      unless request_stub
+        raise LWS::Errors::StubError, "no such request stub"
+      end
       remove_request_stub request_stub
     end
 

data/lib/lws/version.rb

@@ -13,6 +13,6 @@ module LWS
 
   # The LWS library version.
   # @note The major and minor version parts match the LWS API version!
-  VERSION = '6.1.0.beta4'
+  VERSION = '6.1.0.beta5'
 
 end

data/lib/lws.rb

@@ -17,6 +17,7 @@ require "pp"
 require "webmock"
 
 require "lws/config"
+require "lws/errors"
 require "lws/middleware"
 require "lws/stubbing"
 require "lws/version"
@@ -31,6 +32,7 @@ WebMock.disable!
 # libraries.
 module LWS
 
+  include Errors
   include Middleware
 
   # The list of supported apps (web service libraries) loaded by
@@ -47,21 +49,31 @@ module LWS
   # Sets up the application API libraries using the provided
   # configuration (see {Config}).
   #
-  # @example Set up LWS with a token, an endpoint override, HTTP debugging and the Rails logger
+  # @example Set up LWS with a token and the development environment
   #   LWS.setup do |config|
   #     config.api_token = "MY_TOKEN"
-  #     config.endpoints = { maps: https://maps-dev.leftclick.cloud }
+  #     config.environment = :development
+  #   end
+  #
+  # @example Set up LWS with API token middleware, caching, the development environment, an map endpoint override and logging to the Rails logger
+  #   LWS.setup do |config|
+  #     config.api_token_middleware = TokenAuthenticator
+  #     config.caching_object = MyRedisCache.new
+  #     config.environment = :development
+  #     config.endponts = { maps: "https://maps.leftclick.cloud" }
   #     config.http_debug = true
+  #     config.json_debug = true
   #     config.logger = Rails.logger
   #   end
   #
+  #
   # The API token can be overridden using the +LC_LWS_API_TOKEN+
   # environment variable.  The LWS environment can be overriden using the
   # +LC_LWS_ENV+ environment variable.
   #
   # @yieldparam [Config] config an API configuration object that can be
   #   configured
-  # @raise if API token is not configured
+  # @raise [LWS::Errors::ConfigError] if the API token is not configured/found
   # @return [LWS] the module itself
   def self.setup(&block)
     @@config = Config.new
@@ -79,7 +91,8 @@ module LWS
     end
 
     if config.api_token.blank? and config.api_token_middleware.blank?
-      raise "API token or API token middleware is required"
+      raise LWS::Errors::ConfigError,
+        "API token or API token middleware is required"
     end
 
     load_app_modules

data/test/fixtures/auth.yml

@@ -39,35 +39,35 @@ auth:
     - *account_1
     post_default: *account_1
 
-  /companies/1:
-    default: &company_1
-      id: 1
-      contact_person_id: 1
-      parent_id: null
-
-  /companies:
-    default:
-    - *company_1
-    post_default: *company_1
-
-  /devices/1:
+  /accounts/1/devices/1:
     default: &device_1
       id: 1
       account_id: 1
       name: Test Device
 
-  /devices:
+  /accounts/1/devices:
     default:
     - *device_1
     post_default: *device_1
 
-  /users/1:
+  /accounts/1/users/1:
     default: &user_1
       id: 1
       account_id: 1
       email: test.user@leftclick.eu
 
-  /users:
+  /accounts/1/users:
     default:
     - *user_1
     post_default: *user_1
+
+  /companies/1:
+    default: &company_1
+      id: 1
+      contact_person_id: 1
+      parent_id: null
+
+  /companies:
+    default:
+    - *company_1
+    post_default: *company_1

data/test/generic_test.rb

@@ -20,11 +20,37 @@ class TestGenericConfiguration < MiniTest::Test
     @configuration = Configuration.all.first
   end
 
-  # FIXME: renable this test once some configurations are available again
-  #def test_valid_configuration
-  #  refute_nil(@configuration)
-  #  assert_instance_of(Configuration, @configuration)
-  #  refute_nil(@configuration.id)
-  #end
+  def test_valid
+    refute_nil(@configuration)
+    assert_instance_of(Configuration, @configuration)
+    refute_nil(@configuration.id)
+  end
+
+  def test_lifecycle
+    # Create
+    new_configuration = Configuration.create(key: "test", value: "some_value")
+    refute_nil(new_configuration)
+    assert_instance_of(Configuration, new_configuration)
+
+    # Retrieve
+    new_configuration = Configuration.find(new_configuration.id)
+    refute_nil(new_configuration)
+    assert_instance_of(Configuration, new_configuration)
+    assert_raises LWS::Errors::ResourceNotFound do
+      Configuration.find("does_not_exist")
+    end
+
+    # Update
+    new_configuration.value = "other_value"
+    assert(new_configuration.save)
+    new_configuration.reload
+    assert_equal("other_value", new_configuration.value)
+
+    # Destroy
+    assert(new_configuration.destroy)
+    assert_raises LWS::Errors::ResourceNotFound do
+      Configuration.find(new_configuration.id)
+    end
+  end
 
 end

data/test/json_parser_test.rb

@@ -25,11 +25,16 @@ class TestJSONParser < MiniTest::Test
     full_uri = LWS::Auth.api.url_prefix.dup
     full_uri.path = "/companies/broken"
     stub_request(:get, full_uri.to_s).to_return(body: "{}invalid json")
+    full_uri.path = "/companies/empty"
+    stub_request(:get, full_uri.to_s).to_return(body: "")
     full_uri.path = "/companies/correct"
     stub_request(:get, full_uri.to_s)
       .to_return(body: MultiJson.dump(company))
     stub_request(:put, full_uri.to_s)
       .to_return(body: MultiJson.dump(company.merge(errors: { ticket: ["is an invalid field"] })))
+    full_uri.path = "/companies"
+    stub_request(:post, full_uri.to_s)
+      .to_return(body: "", status: 204)
   end
 
   def teardown
@@ -37,7 +42,7 @@ class TestJSONParser < MiniTest::Test
   end
 
   def test_broken_json
-    assert_raises MultiJson::ParseError do
+    assert_raises LWS::Errors::InvalidResponse do
       company = LWS::Auth::Company.find("broken")
     end
   end
@@ -47,6 +52,11 @@ class TestJSONParser < MiniTest::Test
     assert_equal "correct", company.id
   end
 
+  def test_no_content_json
+    company = LWS::Auth::Company.create
+    assert_instance_of LWS::Auth::Company, company
+  end
+
   def test_correct_json_with_errors
     company = LWS::Auth::Company.find("correct")
     company.ticket = "unknown attribute"

data/test/setup_test.rb

@@ -13,13 +13,15 @@ require "test_helper"
 
 class TestSetup < MiniTest::Test
 
+  def teardown
+    # Restore the configuration
+    reconfigure
+  end
+
   def test_cannot_leave_out_api_token
     assert_raises do
       LWS.setup { }
     end
-
-    # Restore the configuration
-    reconfigure
   end
 
   def test_get_environment_from_environment
@@ -39,9 +41,28 @@ class TestSetup < MiniTest::Test
       reconfigure
     end
     assert_equal(LWS.config.api_token, "test-token")
+  end
 
-    # Restore the configuration
-    reconfigure
+  def test_http_logging_without_logger
+    reconfigure(logger: nil,
+                http_debug: true,
+                http_debug_headers: true,
+                json_debug: false)
+
+    assert_raises LWS::Errors::ConfigError do
+      LWS::Auth::Token.find(0)
+    end
+  end
+
+  def test_json_logging_without_logger
+    reconfigure(logger: nil,
+                http_debug: false,
+                http_debug_headers: false,
+                json_debug: true)
+
+    assert_raises LWS::Errors::ConfigError do
+      LWS::Auth::Token.find(0)
+    end
   end
 
 end

data/test/stubbing_test.rb

@@ -22,6 +22,12 @@ class TestStubbing < MiniTest::Test
     reconfigure
   end
 
+  def test_not_working_stubbing
+    assert_raises LWS::Errors::ConfigError do
+      reconfigure(stubbing: "/fixtures/doesnotexist")
+    end
+  end
+
   def test_working_stubbing
     assert_raises WebMock::NetConnectNotAllowedError do
       LWS::Auth::Token.find("not_stubbed")
@@ -32,7 +38,7 @@ class TestStubbing < MiniTest::Test
 
   def test_working_stubbing_with_status
     LWS.stubbing.replace(:get, :auth, "/tokens/does_not_exist", :default, 404)
-    assert_raises Spyke::ResourceNotFound do
+    assert_raises LWS::Errors::ResourceNotFound do
       LWS::Auth::Token.find("does_not_exist")
     end
   end
@@ -42,11 +48,23 @@ class TestStubbing < MiniTest::Test
     assert LWS.stubbing.replace(:get, :auth, "/tokens/1", nil)
   end
 
+  def test_failed_replace_stub
+    assert_raises LWS::Errors::StubError do
+      LWS.stubbing.replace(:get, :auth, "/some/nonexisting/path", :not_here)
+    end
+  end
+
   def test_remove_stub
-    stub = LWS.stubbing.remove(:get, :auth, "/devices/1")
+    stub = LWS.stubbing.remove(:get, :auth, "/accounts/1/devices/1")
     assert_nil stub
-    assert_raises RuntimeError do
-      LWS.stubbing.remove(:get, :auth, "/devices/1")
+    assert_raises LWS::Errors::StubError do
+      LWS.stubbing.remove(:get, :auth, "/accounts/1/devices/1")
+    end
+  end
+
+  def test_failed_remove_stub
+    assert_raises LWS::Errors::StubError do
+      LWS.stubbing.remove(:get, :auth, "/some/nonexisting/path")
     end
   end
 

data/test/test_helper.rb

@@ -48,9 +48,9 @@ def reconfigure(options = {})
     config.api_token = ENV["LC_LWS_TEST_TOKEN"]
     if ENV["LC_LWS_TEST_DEBUG"].present?
       config.logger = Logger.new($stdout)
-      config.http_debug = false
+      config.http_debug = true
       config.http_debug_headers = false
-      config.json_debug = false
+      config.json_debug = true
     end
     config.environment = :development
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 6.1.0.beta4
+  version: 6.1.0.beta5
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -244,6 +244,7 @@ files:
 - lib/lws/apps/presence.rb
 - lib/lws/apps/ticket.rb
 - lib/lws/config.rb
+- lib/lws/errors.rb
 - lib/lws/middleware.rb
 - lib/lws/middleware/http_logger.rb
 - lib/lws/middleware/json_logger.rb