lws 0.4.2 → 6.1.0.beta1

data/lib/lws/generic.rb

@@ -15,65 +15,61 @@
 module LWS::Generic
 
   # = The generic model class
-  class Model
-    include Her::Model
-
+  #
+  # This model forms the base for all LWS models.
+  class Model < Spyke::Base
     include_root_in_json true
+
+    # @private
+    # @!visibility private
+    #
+    # Adds an attribute for this class.
+    #
+    # @note
+    #   This is just a singular version helper method of the +attributes+
+    #   method provided by Spyke.
+    # @param [Symbol] name the name of the attribute to add
+    # @return [void]
+    def self.attribute(name)
+      attributes(name)
+    end
+
+    # @private
+    # @!visibility private
+    #
+    # Sets the Faraday API object used for this class.  This will used by
+    # Spyke.
+    #
+    # @param api The Faraday connection that makes requests to the API
+    # @return [Faraday] A Faraday connection that makes requests to the API
+    def self.use_api(api)
+      self.connection = api
+      self.include_root_in_json self.name.split("::").last.underscore.to_sym
+      api
+    end
   end
 
   # = The configuration class
   class Configuration < Model
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the configuration
-
-    #@!attribute key
-    #  @return [String] the configuration key
-
-    #@!attribute value
-    #  @return [String] the configuration value
-
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the configuration was created
-
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the configuration was last updated
-
-    self # To ensure that YARD does not skip the attributes of this class
-  end
-
-  # = The task class
-  class Task < Model
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the task
-
-    #@!attribute name
-    #  @return [String] the name of the task
-
-    #@!attribute interval
-    #  @return [Fixnum] the interval in minutes
-
-    #@!attribute function
-    #  @return [String] the function to run
-
-    #@!attribute last_ran
-    #  @return [String] the time the task was last run
-
-    #@!attribute started
-    #  @return [String] the time the task was started
-
-    #@!attribute node_name
-    #  @return [String] the name of the node
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the configuration
+    attribute :id
 
-    #@!attribute pid
-    #  @return [String] the process ID of the task
+    # @!attribute key
+    #   @return [String] the configuration key
+    attribute :key
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the map was created
+    # @!attribute value
+    #   @return [String] the configuration value
+    attribute :value
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the map was last updated
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the configuration was created
+    attribute :created_at
 
-    self # To ensure that YARD does not skip the attributes of this class
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the configuration was last updated
+    attribute :updated_at
   end
 
 end

data/lib/lws/maps.rb

@@ -20,7 +20,7 @@ module LWS::Maps
   end
   # :nocov:
 
-  #@!visibility private
+  # @!visibility private
   def self.api
     LWS.setup_api(LWS.config.endpoints[:maps] ||
                   ENDPOINT[LWS.config.environment])
@@ -33,72 +33,118 @@ module LWS::Maps
     use_api LWS::Maps.api
   end
 
-  # (see Generic::Task)
-  class Task < LWS::Generic::Task
-    use_api LWS::Maps.api
-  end
-
   ### App specific classes
 
   # = The map class
   class Map < LWS::Generic::Model
     use_api LWS::Maps.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the map
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the map
+    attribute :id
 
-    #@!attribute company
-    #  @return [LWS::Auth::Company] the company that maintains/owns the map
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company that maintains/owns the map
     belongs_to :company, class_name: "LWS::Auth::Company"
 
-    #@!attribute company_id
-    #  @return [Fixnum] the ID of the company that maintains/owns the map
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company that maintains/owns the map
+    attribute :company_id
 
-    #@!attribute markers
-    #  @return [Array<Marker>] the list of associated markers
+    # @!attribute markers
+    #   @return [Array<Marker>] the list of associated markers
     has_many :markers
 
-    #@!attribute name
-    #  @return [String] the name of the map
+    # @!attribute name
+    #   @return [String] the name of the map
+    attribute :name
+
+    # @!attribute source
+    #   @return [Source] the map source used for tiling the map
+    belongs_to :source
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the map was created
+    # @!attribute source_id
+    #   @return [Fixnum] the ID of the map source used for tiling the map
+    attribute :source_id
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the map was last updated
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the map was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the map was last updated
+    attribute :updated_at
   end
 
   # = The map marker class
   class Marker < LWS::Generic::Model
     use_api LWS::Maps.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the map marker
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the map marker
+    attribute :id
+
+    # @attribute lat
+    #   @return [String, nil] the latitude of the map marker
+    attribute :lat
+
+    # @attribute long
+    #   @return [String, nil] the longitued of the map marker
+    attribute :long
 
-    #@!attribute map
-    #  @return [Map] the map that the marker is placed on
+    # @!attribute map
+    #   @return [Map] the map that the marker is placed on
     belongs_to :map
 
-    #@!attribute map_id
-    #  @return [Fixnum] the ID  of the map that the marker is placed on
+    # @!attribute map_id
+    #   @return [Fixnum] the ID of the map that the marker is placed on
+    attribute :map_id
+
+    # @!attribute name
+    #   @return [String] the name of the map marker
+    attribute :name
+
+    # @attribute website
+    #   @return [String, nil] the website URL of the map marker
+    attribute :website
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the map marker was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the map marker was last updated
+    attribute :updated_at
+  end
+
+  # = The map source class
+  class Source < LWS::Generic::Model
+    use_api LWS::Maps.api
 
-    #@!attribute name
-    #  @return [String] the name of the map marker
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the map source
+    attribute :id
 
-    #@attribute lat
-    #  @return [String] the latitude of the map marker
+    # @!attribute key
+    #   @return [String] the key used by the map implementation to select the
+    #      map source
+    attribute :key
 
-    #@attribute long
-    #  @return [String] the longitued of the map marker
+    # @!attribute maps
+    #   @return [Array<Map>] the maps using the map source
+    has_many :maps
 
-    #@attribute website
-    #  @return [String] the website URL of the map marker
+    # @!attribute name
+    #   @return [String] the name of the map source
+    attribute :name
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the map marker was created
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the map source was created
+    attribute :created_at
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the map marker was last updated
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the map source was last updated
+    attribute :updated_at
   end
 
 end

data/lib/lws/presence.rb

@@ -20,7 +20,7 @@ module LWS::Presence
   end
   # :nocov:
 
-  #@!visibility private
+  # @!visibility private
   def self.api
     LWS.setup_api(LWS.config.endpoints[:presence] ||
                   ENDPOINT[LWS.config.environment])
@@ -33,117 +33,137 @@ module LWS::Presence
     use_api LWS::Presence.api
   end
 
-  # (see Generic::Task)
-  class Task < LWS::Generic::Task
-    use_api LWS::Presence.api
-  end
-
   ### App specific classes
 
   # = The location class
   class Location < LWS::Generic::Model
     use_api LWS::Presence.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the location
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the location
+    attribute :id
 
-    #@!attribute name
-    #  @return [String] the name of the location
-
-    #@!attribute lat
-    #  @return [Float] the latitude of the location
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the location belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
 
-    #@!attribute long
-    #  @return [Float] the longitude of the location
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company the location belongs to
+    attribute :company_id
 
-    #@!attribute range
-    #  @return [Integer] the range around the location in meters
+    # @!attribute lat
+    #   @return [Float] the latitude of the location
+    attribute :lat
 
-    #@!attribute logoff_time
-    #  @return [String] the time everybody is automatically logged off
-    #     (format HH:MM)
+    # @!attribute logoff_time
+    #   @return [String] the time everybody is automatically logged off
+    #      (format HH:MM)
+    attribute :logoff_time
 
-    #@!attribute company
-    #  @return [Auth::Company] the company the location belongs to
-    belongs_to :company, class_name: "LWS::Auth::Company"
+    # @!attribute long
+    #   @return [Float] the longitude of the location
+    attribute :long
 
-    #@!attribute company_id
-    #  @return [Fixnum] the ID of the company the location belongs to
+    # @!attribute name
+    #   @return [String] the name of the location
+    attribute :name
 
-    #@!attribute people
-    # @return [Array<Person>] the people associated with the location
+    # @!attribute people
+    #  @return [Array<Person>] the people associated with the location
     has_many :people
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the location was created
+    # @!attribute range
+    #   @return [Integer] the range around the location in meters
+    attribute :range
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the location was created
+    attribute :created_at
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the location was last updated
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the location was last updated
+    attribute :updated_at
   end
-  
+
   # = The person class
   class Person < LWS::Generic::Model
     use_api LWS::Presence.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the person
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the person
+    attribute :id
 
-    #@!attribute name
-    #  @return [String] the name of the person
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the person belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
 
-    #@!attribute udid
-    #   @return [String] the unique device ID (e.g. of a mobile phone)
-    #     linked to the person
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company the person belongs to
+    attribute :company_id
 
-    #@!attribute rfid
-    #  @return [String] the RFID tag ID linked to the person
+    # @!attribute customer_reference
+    #   @return [String, nil] the customer specific reference for the person
+    attribute :customer_reference
 
-    #@!attribute company
-    #  @return [Auth::Company] the company the person belongs to
-    belongs_to :company, class_name: "LWS::Auth::Company"
+    # @!attribute ero
+    #  @return [Boolean] whether the person is emergency response
+    #    certified
+    attribute :ero
 
-    #@!attribute company_id
-    #  @return [Fixnum] the ID of the company the person belongs to
+    # @!attribute extra_info
+    #   @return [String, nil] some extra info for the person
+    attribute :extra_info
 
-    #@!attribute lat
-    #  @return [Float] the exact latitude of the person's location
+    # @!attribute last_sync
+    #   @return [String, nil] the last date/time the status was updated via a
+    #      device or RFID tag
+    attribute :last_sync
 
-    #@!attribute long
-    #  @return [Float] the exact longitude of the person's location
+    # @!attribute lat
+    #   @return [Float, nil] the exact latitude of the person's location
+    attribute :lat
 
-    #@!attribute status
-    #  @return ["available", "busy", "away", "disabled"] the presence status
-    #    of the person
+    # @!attribute long
+    #   @return [Float, nil] the exact longitude of the person's location
+    attribute :long
 
-    #@!attribute location
-    #  @return [Location] the location the person is located at
+    # @!attribute location
+    #   @return [Location] the location the person is located at
     belongs_to :location
 
-    #@!attribute location_id
-    #  @return [Fixnum] the ID of the location the person is located at
+    # @!attribute location_id
+    #   @return [Fixnum] the ID of the location the person is located at
+    attribute :location_id
 
-    #@!attribute extra_info
-    #  @return [String] some extra info for the person
+    # @!attribute name
+    #   @return [String] the name of the person
+    attribute :name
 
-    #@!attribute customer_reference
-    #  @return [String] customer specific reference for the person
+    # @!attribute picture_url
+    #   @return [String, nil] the URL of the picture of the person
+    attribute :picture_url
 
-    #@!attribute ero
-    # @return [Boolean] flag whether the person is emergency response
-    #   certified
+    # @!attribute rfid
+    #   @return [String, nil] the RFID tag ID linked to the person
+    attribute :rfid
 
-    #@!attribute picture_url
-    #  @return [String] an URL of the picture of the person
+    # @!attribute status
+    #   @return ["available", "busy", "away", "disabled", nil]
+    #     the presence status of the person
+    attribute :status
 
-    #@!attribute last_sync
-    #  @return [String] last time the status was updated via a device or
-    #    RFID tag
+    # @!attribute udid
+    #    @return [String, nil] the unique device ID (e.g. of a mobile phone)
+    #      linked to the person
+    attribute :udid
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the person was created
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the person was created
+    attribute :created_at
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the person was last updated
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the person was last updated
+    attribute :updated_at
   end
 
 end

data/lib/lws/stubbing.rb

@@ -96,8 +96,8 @@ module LWS
                   {}
                 end
       raise "fixture #{fixture_name} not found (app: #{app_name}, URI: #{path})" unless fixture
-      app_endpoint_url = LWS.app_module(app_name).api.options[:url]
-      app_endpoint_uri = URI.parse(app_endpoint_url)
+      app_module = LWS.app_module(app_name)
+      app_endpoint_uri = app_module.api.url_prefix.dup
       app_endpoint_uri.path = path
       full_uri = "%s://%s:%s%s" % [app_endpoint_uri.scheme,
                                    app_endpoint_uri.host,