lws 6.1.0.beta6 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4481ad17a1652e8cb7f0f1979c136f1f5849a239
-  data.tar.gz: bd6ca219e14eeedb2fdfa11c56a772901a494032
+  metadata.gz: 2eb1ec948cd52f1f5c3610ac4c3fc04d0ee1c711
+  data.tar.gz: 6368649a24fa9016db6e9e0ca52b77528ad83df2
 SHA512:
-  metadata.gz: 2aaf64b05526bd03a3bab74caa925aeb4a22707fecc3f965be37db5aafb0f9a01674873df9cb524ac5638394e03f46bf2405c69c8853e7188d3f83c1588410fb
-  data.tar.gz: b2f35929acd6b44b2cc348c66918a763bc1795792d2efcc422397db8874dd098654f9eb2041597c2b350a0798f57724a98f1e1d4ebf3584288294ac38ce818f4
+  metadata.gz: b669df0b60760d421f95d4994ff01d554758a40d54767982eb00705cbd988e2a10503200bd1eda281e94ddc3127bc303ede13c75c719e2c9575d0c9b1fd2a3cf
+  data.tar.gz: 0fd2381ff359b7be8e30c13622d663ccec20ab30e89404cb52127c29f2cb25a950deba303e04bfe6a9fe8a39d75a6385f0358b92630296599bd12d3bb46a64c8

data/CHANGELOG.md

@@ -0,0 +1,54 @@
+# LWS Changelog
+
+Up until v6.1.0, we used the standard Gem version numbering starting at v0.0.1.
+From v6.1.0 on the version will follow the API version of LWS in the major/minor
+part of te version.
+
+## v6.1.0
+
+* Switch to LWS/LeftClick platform release versions
+* Switch to Spyke as the REST ORM library (closes: #10671)
+* Add some Her backward compatibility support
+* Use JSON as the wire format for sending data to LWS
+* Switch to using our own exceptions (see LWS::Errors)
+* Add support for setting the LWS API token in the environment
+* Switch to Pry as the REPL used by the LWS console
+* Add commands to the LWS console to toggle debug options
+* Add option parsing and app/environment/debug mode selection to LWS console
+
+### Apps
+
+* Add a first implementation of the Digital Signage app (closes: #11110)
+* Update some fields for the Ticket app (closes: #11997)
+* Add the Reader model to the Presence app, add fields to the Location model
+
+### Development
+
+* Reorganize the file structure of the library
+* Add and improve tests and documentation
+* Document and fix model relations throughout all apps
+* Documentation fixes for switch to Spyke
+
+## v0.4.2
+
+* Documentation fixes
+* Obtain full test coverage by adding some tests
+
+## v0.4.1
+
+* Test improvements; use simplecov for coverage metrics.
+
+## v0.4.0
+
+* Add support for the ticket and corporate website app/web service
+* Gem/packaging and documentation fixes
+
+## v0.3.1
+
+* Add a release_if_needed task
+
+…
+
+## v0.0.1
+
+Initial release

data/README.md

@@ -0,0 +1,85 @@
+# LeftClick Web Services
+
+LWS is a library for Ruby provides access to the LeftClick web
+services/applications using a model-based structure that abstracts from API
+calls using the available REST interfaces.
+
+## Installation
+
+In your Gemfile, add:
+
+```
+gem "lws"
+```
+
+or install the `ruby-lws` package.
+
+
+## Usage
+
+First, you have to initialize the library.  For example, with Rails, you
+would create a new `config/initializers/lws.rb` file with these lines:
+
+```ruby
+# config/initializers/lws.rb
+LWS.setup do |config|
+  config.api_token = "…" # Get it from someplace
+end
+```
+
+After that, due to the fact that LWS is based on
+[Spyke](https://github.com/balvig/spyke), you can access the objects in the
+LeftClick Web Services similary to many ActiveRecord-like ORM's:
+
+```ruby
+map = Maps::Map.all.first
+markers = map.markers
+
+company = Company.find(6)
+account = Auth::Account.create(name: "Foo Bar",
+                               company: company)
+
+loc = Presence::Location.where(name: "Test")
+loc.destroy
+```
+
+## Configuration
+
+The following example uses a much more elaborate setup:
+
+```ruby
+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
+```
+
+In this setup, a caching object is used that follows the
+`FaradayMiddleWare::Caching` API.  It uses all development API endpoints,
+except for maps, which is overriden to use the production endpoint.  Also
+HTTP request and JSON data debug logging is enabled and LWS will use
+the Rails logger to log the messages.
+Also a custom API token authenticator class is used that should implement
+the `Faraday::Middleware` interface and set the `X-Token` header with the
+runtime determined API token as value, for example:
+
+```ruby
+class TokenAuthenticator < Faraday::Middleware
+
+  def call(env)
+    env[:request_headers]["X-Token"] = … # Some calculated token
+    @app.call(env)
+  end
+
+end
+```
+
+The `LC_LWS_ENV` environment variable is supported to override the LWS
+environment.  Allowed values are "production" (default) and "development".
+The `LC_LWS_API_TOKEN` is supported to set the LWS API token default.
+This only works if a custom API token middleware is not used.

data/Rakefile

@@ -22,7 +22,7 @@ Rake::TestTask.new do |t|
 end
 
 YARD::Rake::YardocTask.new do |t|
-  t.files = ["lib/**/*.rb", "-", "README.rdoc"]
+  t.files = ["lib/**/*.rb", "-", "README.md", "CHANGELOG.md"]
   t.options = ["--no-private",
                "--title", "LeftClick Web Services Documentation"]
 end

data/lib/lws/apps/presence.rb

@@ -43,6 +43,21 @@ module LWS::Presence
     #   @return [Fixnum] the (unique) ID of the location
     attribute :id
 
+    # @!attribute capacity
+    #   @return [Fixnum] the capacity (maximum number of people) of the location
+    #      (including descendant locations)
+    attribute :capacity
+
+    # @!attribute capacity_used
+    #   @return [Fixnum] the used capacity (present number of people) of the location
+    #      (including descendant locations)
+    attribute :capacity_used
+
+    # @!attribute capacity_used_percentage
+    #   @return [Float] the used capacity percentage of the location
+    #     (including descendant locations)
+    attribute :capacity_used_precentage
+
     # @!attribute company
     #   @return [LWS::Auth::Company] the company the location belongs to
     belongs_to :company, class_name: "LWS::Auth::Company"
@@ -64,10 +79,24 @@ module LWS::Presence
     #   @return [Float] the longitude of the location
     attribute :long
 
+    # @!attribute map_location_id
+    #   @note
+    #     There is not a relation for this at the moment!
+    #   @return [Fixnum] the ID of the map location associated with the location
+    attribute :map_location_id
+
     # @!attribute name
     #   @return [String] the name of the location
     attribute :name
 
+    # @!attribute parent
+    #  @return [Location] the parent of the location
+    belongs_to :parent, class_name: "LWS::Presence::Location"
+
+    # @!attribute parent_id
+    #  @return [Fixnum] the ID of the parent of the location
+    attribute :parent_id
+
     # @!attribute people
     #  @return [Array<Person>] the people associated with the location
     has_many :people
@@ -76,6 +105,10 @@ module LWS::Presence
     #   @return [Integer] the range around the location in meters
     attribute :range
 
+    # @!attribute readers
+    #   @return [Array<Reader>] the (RFID/code/ID/...) readers linked to this location
+    has_many :readers
+
     # @!attribute created_at [r]
     #   @return [String] the timestamp of when the location was created
     attribute :created_at
@@ -166,4 +199,37 @@ module LWS::Presence
     attribute :updated_at
   end
 
+  # = The reader class
+  class Reader < LWS::Generic::Model
+    use_api LWS::Presence.api
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the reader
+    attribute :id
+
+    # @!attribute gateway
+    #   @return [Fixnum] the (32-bit) LCIO gateway ID of the reader
+    attribute :gateway
+
+    # @!attribute location
+    #   @return [Location] the location of the reader
+    belongs_to :location
+
+    # @!attribute location_id
+    #   @return [Fixnum] the ID of the location of the reader
+    attribute :location_id
+
+    # @!attribute node
+    #   @return [Fixnum] the (8-bit) LCIO gateway node number of the reader
+    attribute :node
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the reader was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the reader was last updated
+    attribute :updated_at
+  end
+
 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.beta6'
+  VERSION = '6.1.0'
 
 end

data/test/presence_test.rb

@@ -28,6 +28,7 @@ class TestPresenceLocation < MiniTest::Test
   def test_valid_associations
     assert_instance_of(LWS::Auth::Company, @location.company)
     assert_instance_of(Person, @location.people.first)
+    assert_instance_of(Reader, @location.readers.first)
   end
 
 end
@@ -52,3 +53,23 @@ class TestPresencePerson < MiniTest::Test
   end
 
 end
+
+class TestPresenceReader < MiniTest::Test
+
+  include LWS::Presence
+
+  def setup
+    @reader = Reader.all.first
+  end
+
+  def test_valid
+    refute_nil(@reader)
+    assert_instance_of(Reader, @reader)
+    refute_nil(@reader.id)
+  end
+
+  def test_valid_associations
+    assert_instance_of(Location, @reader.location)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 6.1.0.beta6
+  version: 6.1.0
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-18 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -230,8 +230,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - bin/lwsconsole
 - copyright.txt
@@ -284,9 +285,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1

data/README.rdoc

@@ -1,75 +0,0 @@
-= LeftClick Web Services
-
-LWS is a library for Ruby provides access to the LeftClick web
-services/applications using a model-based structure that abstracts from API
-calls using the available REST interfaces.
-
-== Installation
-
-In your Gemfile, add:
-
-  gem "lws"
-
-or install the +ruby-lws+ package.
-
-
-== Usage
-
-First, you have to initialize the library.  For example, with Rails, you
-would create a new +config/initializers/lws.rb+ file with these lines:
-
-  # config/initializers/lws.rb
-  LWS.setup do |config|
-    config.api_token = "…" # Get it from someplace
-  end
-
-After that, due to the fact that LWS is based on
-[Spyke](https://github.com/balvig/spyke), you can access the objects in the
-LeftClick Web Services similary to many ActiveRecord-like ORM's:
-
-  map = Maps::Map.all.first
-  markers = map.markers
-
-  company = Company.find(6)
-  account = Auth::Account.create(name: "Foo Bar",
-                                 company: company)
-
-  loc = Presence::Location.where(name: "Test")
-  loc.destroy
-
-== Configuration
-
-The following example uses a much more elaborate setup:
-
-  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
-
-In this setup, a caching object is used that follows the
-+FaradayMiddleWare::Caching+ API.  It uses all development API endpoints,
-except for maps, which is overriden to use the production endpoint.  Also
-HTTP request and JSON data debug logging is enabled and LWS will use
-the Rails logger to log the messages.
-Also a custom API token authenticator class is used that should implement
-the +Faraday::Middleware+ interface and set the +X-Token+ header with the
-runtime determined API token as value, for example:
-
-  class TokenAuthenticator < Faraday::Middleware
-
-    def call(env)
-      env[:request_headers]["X-Token"] = … # Some calculated token
-      @app.call(env)
-    end
-
-  end
-
-The +LC_LWS_ENV+ environment variable is supported to override the LWS
-environment.  Allowed values are "production" (default) and "development".
-The +LC_LWS_API_TOKEN+ is supported to set the LWS API token default.
-This only works if a custom API token middleware is not used.