lws 0.1.5 → 0.1.6

data/lib/lws/auth.rb

@@ -37,6 +37,18 @@ module LWS::Auth
     #@!attribute avatar_url
     #  @return [String] the avatar URL of the account
 
+    #@!attribute apps
+    #  @return [Array<App>] the apps that are assigned to the account
+    has_many :apps
+
+    #@!attribute devices
+    #  @return [Array<Device>] the devices that are assigned to the account
+    has_many :devices
+
+    #@!attribute users
+    #  @return [Array<User>] the users that are assigned to the account
+    has_many :users
+
     #@!attribute company
     #  @return [Company] the company that the account belongs to
     belongs_to :company
@@ -101,6 +113,14 @@ module LWS::Auth
     #@!attribute id [r]
     #  @return [Fixnum] the (unique) ID of the company
 
+    #@!attribute apps
+    #  @return [Array<App>] the apps that are assigned to the company
+    has_many :apps
+
+    #@!attribute accounts
+    #  @return [Array<Account>] the accounts that are assigned to the company
+    has_many :accounts
+
     #@!attribute address
     #  @return [String] the address of the company
 
@@ -194,14 +214,24 @@ module LWS::Auth
     #@!attribute user_agent
     #  @return [String] the user agent/browser string when the token was used
 
+    #@!attribute account
+    #  @return [Account] the account the token belongs to (through either
+    #    the user or the device)
+    belongs_to :account
+
+    #@!attribute account_id
+    #  @return [Fixnum] the ID of the account the token belongs to
+
     #@!attribute user
-    #  @return [Account] the (user) account the token belongs to
-    belongs_to :user, class_name: "Account"
+    #  @note Each token is associated to either a user or a device.
+    #  @return [User] the user the token belongs to
+    belongs_to :user
 
     #@!attribute user_id
-    #  @return [Fixnum] the ID of the (user) account the token belongs to
+    #  @return [Fixnum] the ID of the user the token belongs to
 
     #@!attribute device
+    #  @note Each token is associated to either a user or a device.
     #  @return [Device] the device the token belongs to
     belongs_to :device
 
@@ -222,4 +252,35 @@ module LWS::Auth
     end
   end
 
+  # = The user class
+  class User < LWS::Generic::Model
+    use_api LWS::Auth.api
+
+    #@!attribute id [r]
+    #  @return [Fixnum] the (unique) ID of the user
+
+    #@!attribute email
+    #  @return [String] the email address of the user
+
+    #@!attribute password_digest
+    #  @return [String] the digested version of the password of the user
+
+    #@!attribute account
+    #  @return [Account] the account that the user belongs to
+    belongs_to :account
+
+    #@!attribute account_id
+    #  @return [Fixnum] the ID of the account that the user belongs to
+
+    #@!attribute created_at
+    #  @return [String] the timestamp of when the user was created
+
+    #@!attribute updated_at
+    #  @return [String] the timestamp of when the user was last updated
+
+    def initialize(attrs = {})
+      super
+    end
+  end
+
 end

data/lib/lws/version.rb

@@ -2,6 +2,6 @@ module LWS
 
   # The LWS library version.
   # @note This is not the API version!
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 
 end

data/lib/lws.rb

@@ -70,13 +70,16 @@ module LWS
   mattr_reader :config
 
   # = The API configuration class
+  #
+  # @note Either the API token or API token middleware needs to be
+  #   configured for LWS to work properly!
   class Config < Hashie::Dash
     #@!attribute api_token
     #  @return [String, nil] the API token necessary to gain access
     property :api_token
 
     #@!attribute api_token_middleware
-    # @return [Fardaday::Middleware, nil] the API token middleware that
+    # @return [Faraday::Middleware, nil] the API token middleware that
     #   provides the API token to the request at runtime
     property :api_token_middleware
 

data/test/test_api_token_middleware.rb

@@ -21,41 +21,27 @@ end
 class TestAPITokenMiddleware < MiniTest::Unit::TestCase
 
   def test_working_token_authenticator
-    LWS.setup do |config|
-      config.api_token = nil
-      config.api_token_middleware = WorkingTokenAuthenticator
-      if ENV["LC_LWS_TEST_DEBUG"].present?
-        config.http_debug = true
-        config.json_debug = true
-      end
-      config.environment = :development
-    end
+    # Configure the working token authenticator instead of the test API token
+    reconfigure(api_token: nil,
+                api_token_middleware: WorkingTokenAuthenticator)
 
     task = LWS::Auth::Task.all.first
     refute_nil(task)
 
     # Restore the token
-    LWS.config.api_token = ENV["LC_LWS_TEST_TOKEN"]
-    LWS.config.api_token_middleware = nil
+    reconfigure
   end
 
   def test_broken_token_authenticator
-    LWS.setup do |config|
-      config.api_token = nil
-      config.api_token_middleware = BrokenTokenAuthenticator
-      if ENV["LC_LWS_TEST_DEBUG"].present?
-        config.http_debug = true
-        config.json_debug = true
-      end
-      config.environment = :development
-    end
+    # Configure the working token authenticator instead of the test API token
+    reconfigure(api_token: nil,
+                api_token_middleware: BrokenTokenAuthenticator)
 
     task = LWS::Auth::Task.all.first
     assert_nil(task)
 
     # Restore the token
-    LWS.config.api_token = ENV["LC_LWS_TEST_TOKEN"]
-    LWS.config.api_token_middleware = nil
+    reconfigure
   end
 
 end

data/test/test_auth.rb

@@ -15,7 +15,14 @@ class TestAuthAccount < MiniTest::Unit::TestCase
   end
 
   def test_valid_account_associations
+    assert_instance_of(App, @account.apps.first)
     assert_instance_of(Company, @account.company)
+    if @account.users.present?
+      assert_instance_of(User, @account.users.first)
+    end
+    if @account.devices.present?
+      assert_instance_of(Device, @account.devices.first)
+    end
   end
 
 end
@@ -51,7 +58,9 @@ class TestAuthCompany < MiniTest::Unit::TestCase
   end
 
   def test_valid_company_associations
+    assert_instance_of(Account, @company.accounts.first)
     assert_instance_of(Account, @company.contact_person)
+    assert_instance_of(App, @company.apps.first)
   end
 
 end
@@ -81,7 +90,7 @@ class TestAuthToken < MiniTest::Unit::TestCase
   include LWS::Auth
 
   def setup
-    @token = Token.all.first
+    @token = Token.find(ENV["LC_LWS_TEST_TOKEN"])
   end
 
   def test_valid_token
@@ -92,13 +101,36 @@ class TestAuthToken < MiniTest::Unit::TestCase
   end
 
   def test_valid_token_associations
+    refute_nil(@token.account)
     if @token.user.present?
-      assert_instance_of(Account, @token.user)
+      assert_instance_of(User, @token.user)
+      assert_equal(@token.user.account.id, @token.account.id)
     elsif @token.device.present?
       assert_instance_of(Device, @token.device)
+      assert_equal(@token.device.account.id, @token.account.id)
     else
-      fail "token should be associated with either an account or a device"
+      fail "token should be associated with either a user or a device"
     end
   end
 
 end
+
+class TestAuthUser < MiniTest::Unit::TestCase
+
+  include LWS::Auth
+
+  def setup
+    @user = User.all.first
+  end
+
+  def test_valid_user
+    refute_nil(@user)
+    assert_instance_of(User, @user)
+    refute_nil(@user.id)
+  end
+
+  def test_valid_user_associations
+    assert_instance_of(Account, @user.account)
+  end
+
+end

data/test/test_helper.rb

@@ -3,11 +3,21 @@ require "minitest/autorun"
 
 raise "Test token not set" if ENV["LC_LWS_TEST_TOKEN"].blank?
 
-LWS.setup do |config|
-  config.api_token = ENV["LC_LWS_TEST_TOKEN"]
-  if ENV["LC_LWS_TEST_DEBUG"].present?
-    config.http_debug = true
-    config.json_debug = true
+def reconfigure(options = {})
+  LWS.setup do |config|
+    config.api_token = ENV["LC_LWS_TEST_TOKEN"]
+    if ENV["LC_LWS_TEST_DEBUG"].present?
+      config.http_debug = true
+      config.json_debug = true
+    end
+    config.environment = :development
+
+    # Override the config with the given options.
+    options.each do |key, value|
+      config[key] = value
+    end
   end
-  config.environment = :development
 end
+
+# Perform initial configuration.
+reconfigure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &14765880 !ruby/object:Gem::Requirement
+  requirement: &8912660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *14765880
+  version_requirements: *8912660
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &14764980 !ruby/object:Gem::Requirement
+  requirement: &8911800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14764980
+  version_requirements: *8911800
 - !ruby/object:Gem::Dependency
   name: her
-  requirement: &14764260 !ruby/object:Gem::Requirement
+  requirement: &8911060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *14764260
+  version_requirements: *8911060
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &14763660 !ruby/object:Gem::Requirement
+  requirement: &8910480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14763660
+  version_requirements: *8910480
 - !ruby/object:Gem::Dependency
   name: her
-  requirement: &14762960 !ruby/object:Gem::Requirement
+  requirement: &8909760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: 0.8.1
   type: :development
   prerelease: false
-  version_requirements: *14762960
+  version_requirements: *8909760
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &14762380 !ruby/object:Gem::Requirement
+  requirement: &8909180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +79,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14762380
+  version_requirements: *8909180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &14778140 !ruby/object:Gem::Requirement
+  requirement: &8924920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,7 +90,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *14778140
+  version_requirements: *8924920
 description: ! "This library for Ruby provides access to the LeftClick\n web services/applications
   using a model-based structure that abstracts from API calls\n using the available
   REST interfaces."