lws 0.4.2 → 6.1.0.beta1

data/lib/lws/ticket.rb

@@ -20,7 +20,7 @@ module LWS::Ticket
   end
   # :nocov:
 
-  #@!visibility private
+  # @!visibility private
   def self.api
     LWS.setup_api(LWS.config.endpoints[:ticket] ||
                   ENDPOINT[LWS.config.environment])
@@ -33,244 +33,297 @@ module LWS::Ticket
     use_api LWS::Ticket.api
   end
 
-  # (see Generic::Task)
-  class Task < LWS::Generic::Task
-    use_api LWS::Ticket.api
-  end
-
   ### App specific classes
 
-  # = The ticket class
-  class Ticket < LWS::Generic::Model
+  # = The ticket message attachment class
+  class Attachment < LWS::Generic::Model
     use_api LWS::Ticket.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the ticket
-
-    #@!attribute account
-    #  @return [LWS::Auth::Account] the account of the user that created the
-    #    ticket
-    belongs_to :account, class_name: "LWS::Auth::Account"
-
-    #@!attribute account_id
-    #  @return [Fixnum] the ID of the account of the user that created the
-    #    ticket
-
-    #@!attribute assignee
-    #  @return [LWS::Auth::Account] the account of the user that the ticket
-    #    is assigned to
-    belongs_to :assignee, class_name: "LWS::Auth::Account"
-
-    #@!attribute assignee_id
-    #  @return [Fixnum] the ID of the account of the user that the ticket
-    #    is assigned to
-
-    #@!attribute company
-    #  @return [LWS::Auth::Company] the company of the user that created
-    #    the ticket
-    belongs_to :company, class_name: "LWS::Auth::Company"
-
-    #@!attribute company_id
-    #  @return [Fixnum] the ID of the company of the user that created the
-    #    ticket
-
-    #@!attribute description
-    #  @return [String] the description (body) of the ticket
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the ticket message attachment
+    attribute :id
 
-    #@!attribute display_name
-    #  @return [String] the name of the object the ticket is created for
+    # @!attribute av_scanned_at
+    #   @return [String, nil] the timestamp of when an anti-virus scan on the
+    #     attached file was performed
+    attribute :av_scanned_at
 
-    #@!attribute due_date
-    #  @return [String] the timestamp of when the ticket is due
-
-    #@!attribute group
-    #  @return [String] the group (e.g.  department/ticket type) the ticket
-    #    belongs to
-    belongs_to :group
+    # @!attribute file_object
+    #   @return [String] the URL of the attachment file object
+    attribute :file_object
 
-    #@!attribute group_id
-    #  @return [Fixnum] the ID of the group the ticket belongs to
-
-    #@!attribute messages
-    #  @return [Array<Message>] the messages associated with the ticket
-    has_many :messages
+    # @!attribute message
+    #   @return [Message] the ticket message associated with the attachment
+    belongs_to :message
 
-    #@!attribute owner
-    #  @return [LWS::Auth::Company] the company that is currently handling
-    #    the ticket
-    belongs_to :owner, class_name: "LWS::Auth::Company"
+    # @!attribute message_id
+    #   @return [Fixnum] the ID of the ticket message associated with the
+    #     attachment
+    attribute :message_id
+
+    # @!attribute name
+    #   @return [String] the name of the attachment
+    attribute :name
+
+    # @!attribute size
+    #   @return [Fixnum] the size of the attachment (bytes)
+    attribute :size
+
+    # @!attribute url
+    #   @return [String] the URL to the attachment that can be used to
+    #     download it
+    attribute :url
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the ticket message attachment
+    #     was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the ticket message attachment
+    #     was last updated
+    attribute :updated_at
+  end
 
-    #@!attribute owner_id
-    #  @return [Fixnum] the ID of the company that is currently handling
-    #    the ticket
+  # = The ticket group class
+  class Group < LWS::Generic::Model
+    use_api LWS::Ticket.api
 
-    #@!attribute priority
-    #  @return [Fixnum] the priority (ID) of the ticket
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the ticket group
+    attribute :id
 
-    #@!attribute status
-    #  @return [Fixnum] the current ticket status (ID)
-    
-    #@!attribute tags
-    #  @return [Array<Tag>] the tags associated with the ticket
-    has_many :tags
+    # @!attribute name
+    #   @return [String] the name of the ticket group
+    attribute :name
 
-    #@!attribute target
-    #  The target is a string that consists of three parts joined by a dot.
-    #  It is the name of the app, followed by the model name, followed
-    #  by the model ID.  This can be resolved into the object the ticket
-    #  is created for/on.
-    #
-    #  @return [String] the target of the ticket
+    # @!attribute slug [r]
+    #   @return [String] the slug of the ticket group
+    attribute :slug
 
-    #@!attribute title
-    #  @return [String] the title (short description) of the ticket
+    # @!attribute tickets
+    #   @return [Array<Ticket>] the tickets that are assigned to the ticket
+    #     group
+    has_many :tickets
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the ticket was created
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the ticket group was created
+    attribute :created_at
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the ticket was last updated
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the ticket group was last updated
+    attribute :updated_at
   end
 
   # = The ticket message class
   class Message < LWS::Generic::Model
     use_api LWS::Ticket.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the ticket message
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the ticket message
+    attribute :id
 
-    #@!attribute account
-    #  @return [LWS::Auth::Account] the account of the user that created the
-    #    ticket message
+    # @!attribute account
+    #   @return [LWS::Auth::Account] the account of the user that created the
+    #     ticket message
     belongs_to :account, class_name: "LWS::Auth::Account"
 
-    #@!attribute account_id
-    #  @return [Fixnum] the ID of the account of the user that created the
-    #    ticket message
+    # @!attribute account_id
+    #   @return [Fixnum] the ID of the account of the user that created the
+    #     ticket message
+    attribute :account_id
 
-    #@!attribute attachments
-    #  @return [Array<Attachment>] the attachments associated with the ticket
-    #    message
+    # @!attribute attachments
+    #   @return [Array<Attachment>] the attachments associated with the ticket
+    #     message
     has_many :attachments
 
-    #@!attribute company
-    #  @return [LWS::Auth::Company] the company of the user that created
-    #    the ticket message
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company of the user that created
+    #     the ticket message
     belongs_to :company, class_name: "LWS::Auth::Company"
 
-    #@!attribute company_id
-    #  @return [Fixnum] the ID of the company of the user that created the
-    #    ticket message
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company of the user that created the
+    #     ticket message
+    attribute :company_id
+
+    # @!attribute internal
+    #   @return [Boolean] whether the message is internal, i.e. not visible
+    #     for descendant companies
+    attribute :internal
 
-    #@!attribute message
-    #  @return [String] the ticket message body
+    # @!attribute message
+    #   @return [String] the ticket message body
+    attribute :message
 
-    #@!attribute status
-    #  @return [Fixnum] the new ticket status (ID) set by the message
+    # @!attribute status
+    #   @return [Fixnum] the new ticket status (ID) set by the message
+    attribute :status
 
-    #@!attribute ticket
-    #  @return [Ticket] the ticket associated with the message
+    # @!attribute ticket
+    #   @return [Ticket] the ticket associated with the message
     belongs_to :ticket
 
-    #@!attribute ticket_id
-    #  @return [Fixnum] the ID of the ticket associated with the message
- 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the ticket message was created
+    # @!attribute ticket_id
+    #   @return [Fixnum] the ID of the ticket associated with the message
+    attribute :ticket_id
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the ticket message was last
-    #    updated
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the ticket message was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the ticket message was last
+    #     updated
+    attribute :updated_at
   end
 
-  # = The ticket message attachment class
-  class Attachment < LWS::Generic::Model
+  # = The ticket tag class
+  class Tag < LWS::Generic::Model
     use_api LWS::Ticket.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the ticket message attachment
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the ticket tag
+    attribute :id
 
-    #@!attribute av_scanned_at
-    #  @return [String] the timestamp of when an anti-virus scan on the attached
-    #    file was performed
+    # @!attribute description
+    #   @return [String, nil] the description of the ticket tag
+    attribute :description
 
-    #@!attribute message
-    #  @return [Message] the ticket message associated with the attachment
-    belongs_to :message
+    # @!attribute dev_issue_id
+    #   @return [Fixnum, nil] the ID of the issue in LeftClick's internal bug
+    #     tracking system
+    attribute :dev_issue_id
 
-    #@!attribute message_id
-    #  @return [Fixnum] the ID of the ticket message associated with the
-    #    attachment
+    # @!attribute name
+    #   @return [String] the name of the ticket tag
+    attribute :name
 
-    #@!attribute name
-    #  @return [String] the name of the attachment
+    # @!attribute slug [r]
+    #   @return [String] the slug of the ticket tag
+    attribute :slug
 
-    #@!attribute size
-    #  @return [Fixnum] the size of the attachment (bytes)
+    # @!attribute tickets
+    #   @return [Array<Ticket>] the ticket associated with the tag
+    has_many :tickets
 
-    #@!attribute text
-    #  @return [String] the file object attached
- 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the ticket message attachment
-    #    was created
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the ticket tag was created
+    attribute :created_at
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the ticket message attachment
-    #    was last updated
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the ticket tag was last updated
+    attribute :updated_at
   end
 
-  # = The ticket group class
-  class Group < LWS::Generic::Model
+  # = The ticket class
+  class Ticket < LWS::Generic::Model
     use_api LWS::Ticket.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the ticket group
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the ticket
+    attribute :id
 
-    #@!attribute name
-    #  @return [String] the name of the ticket group
+    # @!attribute account
+    #   @return [LWS::Auth::Account] the account of the user that created the
+    #     ticket
+    belongs_to :account, class_name: "LWS::Auth::Account"
 
-    #@!attribute slug
-    #  @return [String] the slug of the ticket group
- 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the ticket group was created
+    # @!attribute account_id
+    #   @return [Fixnum] the ID of the account of the user that created the
+    #     ticket
+    attribute :account_id
+
+    # @!attribute assignee
+    #   @return [LWS::Auth::Account, nil] the account of the user that the
+    #     ticket is assigned to
+    belongs_to :assignee, class_name: "LWS::Auth::Account",
+                          uri: "accounts/:id"
+
+    # @!attribute assignee_id
+    #   @return [Fixnum, nil] the ID of the account of the user that the
+    #     ticket is assigned to
+    attribute :assignee_id
+
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company of the user that created
+    #     the ticket
+    belongs_to :company, class_name: "LWS::Auth::Company"
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the ticket group was last updated
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company of the user that created the
+    #     ticket
+    attribute :company_id
 
-    self # To ensure that YARD does not skip the attributes of this class
-  end
+    # @!attribute description
+    #   @return [String, nil] the description (body) of the ticket
+    attribute :description
 
-  # = The ticket tag class
-  class Tag < LWS::Generic::Model
-    use_api LWS::Ticket.api
+    # @!attribute display_name
+    #   @return [String] the name of the object the ticket is created for
+    attribute :display_name
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the ticket tag
+    # @!attribute due_date
+    #   @return [String, nil] the timestamp of when the ticket is due
+    attribute :due_date
 
-    #@!attribute description
-    #  @return [String] the description of the ticket tag
+    # @!attribute group
+    #   @return [Group] the group (e.g. department/ticket type) the ticket
+    #     belongs to
+    belongs_to :group
 
-    #@!attribute dev_issue_id
-    #  @return [Fixnum] the ID of the issue in LeftClick's internal bug
-    #    tracking system
+    # @!attribute group_id
+    #   @return [Fixnum] the ID of the group the ticket belongs to
+    attribute :group_id
 
-    #@!attribute name
-    #  @return [String] the name of the ticket tag
+    # @!attribute messages
+    #   @return [Array<Message>] the messages associated with the ticket
+    has_many :messages
 
-    #@!attribute slug
-    #  @return [String] the slug of the ticket tag
+    # @!attribute owner
+    #   @return [LWS::Auth::Company] the company that is currently handling
+    #     the ticket
+    belongs_to :owner, class_name: "LWS::Auth::Company",
+                       uri: "companies/:id"
 
-    #@!attribute ticket
-    #  @return [Ticket] the ticket associated with the tag
-    belongs_to :ticket
- 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the ticket tag was created
+    # @!attribute owner_id
+    #   @return [Fixnum] the ID of the company that is currently handling
+    #     the ticket
+    attribute :owner_id
+
+    # @!attribute priority
+    #   @return [Fixnum] the priority (ID) of the ticket
+    attribute :priority
+
+    # @!attribute status
+    #   @return [Fixnum] the current ticket status (ID)
+    attribute :status
+
+    # @!attribute tags
+    #   @return [Array<Tag>] the tags associated with the ticket
+    has_many :tags
+
+    # @!attribute target
+    #   The target is a string that consists of three parts joined by a dot.
+    #   It is the name of the app, followed by the model name, followed
+    #   by the model ID.  This can be resolved into the object the ticket
+    #   is created for/on.
+    #
+    #   @return [String] the target of the ticket
+    attribute :target
+
+    # @!attribute title
+    #   @return [String] the title (short description) of the ticket
+    attribute :title
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the ticket was created
+    attribute :created_at
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the ticket tag was last updated
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the ticket was last updated
+    attribute :updated_at
   end
 
 end

data/lib/lws/version.rb

@@ -12,7 +12,7 @@
 module LWS
 
   # The LWS library version.
-  # @note This is not the API version!
-  VERSION = '0.4.2'
+  # @note The major and minor version parts match the LWS API version!
+  VERSION = '6.1.0.beta1'
 
 end

data/lib/lws.rb

@@ -11,8 +11,8 @@
 
 require "faraday_middleware"
 require "hashie"
-require "her"
 require "multi_json"
+require "spyke"
 require "pp"
 require "webmock"
 
@@ -31,23 +31,43 @@ module LWS
 
   # The list of supported apps (web service libraries) loaded by
   # {.setup}.
-  SUPPORTED_APPS = [:generic, :auth, :corporate_website, :maps, :presence,
-                    :ticket]
+  SUPPORTED_APPS = [:generic, :auth, :corporate_website, :digital_signage,
+                    :maps, :presence, :ticket]
+
+  # @private
+  # @!visibility private
+  class JSONParser < Faraday::Response::Middleware
+    def parse(body)
+      data = MultiJson.load(body, symbolize_keys: true)
+      metadata = data.delete(:metadata)
+      errors = data.delete(:errors)
+
+      # If there are errors, discard the data.
+      data = nil if errors.present?
+
+      { data: data,
+        metadata: metadata,
+        errors: errors }
+    end
+  end
 
   # @private
   # @!visibility private
   class HTTPLogger < Faraday::Response::Middleware
 
-    def initialize(app, logger)
+    def initialize(app, logger, show_headers)
       raise "cannot log HTTP requests without a logger" if logger.nil?
       @logger = logger
+      @show_headers = show_headers
       super(app)
     end
 
     def call(env)
       @logger.debug ">>> #{env[:method].upcase} #{env[:url].to_s}"
-      env[:request_headers].each do |hdr, val|
-        @logger.debug "    #{hdr}: #{val}"
+      if @show_headers
+        env[:request_headers].each do |hdr, val|
+          @logger.debug "    #{hdr}: #{val}"
+        end
       end
       @logger.debug ">>> #{env[:body] || "nil"}"
       super
@@ -56,8 +76,10 @@ module LWS
     def on_complete(env)
       super
       @logger.debug "<<< HTTP #{env[:status].to_s}"
-      env[:response_headers].each do |hdr, val|
-        @logger.debug "    #{hdr}: #{val}"
+      if @show_headers
+        env[:response_headers].each do |hdr, val|
+          @logger.debug "    #{hdr}: #{val}"
+        end
       end
       @logger.debug "<<< #{env[:body] || "nil"}"
     end
@@ -75,7 +97,7 @@ module LWS
     end
 
     def on_complete(env)
-      dump = MultiJson.dump(env[:body], pretty: true)
+      dump = JSON.pretty_generate(env[:body])
       dump.split("\n").each { |line| @logger.debug "||| #{line}" }
     end
 
@@ -135,6 +157,10 @@ module LWS
     #  @return [Boolean] whether to show HTTP debug messages
     property :http_debug, default: false
 
+    #@!attribute http_debug_headers
+    #  @return [Boolean] whether to show HTTP headers in the debug messages
+    property :http_debug_headers, default: false
+
     #@!attribute json_debug
     #  @return [Boolean] whether to show JSON debug messages
     property :json_debug, default: false
@@ -161,6 +187,10 @@ module LWS
   #     config.logger = Rails.logger
   #   end
   #
+  # A default value for the API token can be set using the
+  # +LC_LWS_API_TOKEN+ environment variable.  The default 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
@@ -169,8 +199,10 @@ module LWS
     @@config = Config.new
     yield @@config
 
-    if config.api_token.blank? and config.api_token_middleware.blank?
-      raise "API token or API token middleware is required"
+    # Override the API token if needed (and no custom API token middleware
+    # is used)
+    if ENV["LC_LWS_API_TOKEN"].present?
+      @@config.api_token = ENV["LC_LWS_API_TOKEN"]
     end
 
     # Override the environment if needed
@@ -178,6 +210,10 @@ module LWS
       @@config.environment = ENV["LC_LWS_ENV"].to_sym
     end
 
+    if config.api_token.blank? and config.api_token_middleware.blank?
+      raise "API token or API token middleware is required"
+    end
+
     load_app_modules
     load_stubbing
 
@@ -186,30 +222,43 @@ module LWS
 
   # @private
   # @!visibility private
+  #
+  # Sets up the Faraday API object with the current LWS configuration for
+  # the given API URL.
+  #
+  # @param api_url The endpoint URL of the API
+  # @return [Faraday] A Faraday connection that makes requests to the API
   def self.setup_api(api_url)
-    api = Her::API.new
-    api.setup(url: api_url) do |c|
+    api = Faraday.new(url: api_url) do |c|
       # Request
       if config.caching_object
         c.use FaradayMiddleware::Caching, config.caching_object
       end
       c.use RequestHeaders, config.api_token
       c.use config.api_token_middleware if config.api_token_middleware.present?
-      c.use Faraday::Request::UrlEncoded
+      c.request :json
 
       # Response
       c.use JSONLogger, config.logger if config.json_debug
-      c.use Her::Middleware::DefaultParseJSON
+      c.use JSONParser
       c.use FaradayMiddleware::FollowRedirects, limit: 3
-      c.use HTTPLogger, config.logger if config.http_debug
+      c.use HTTPLogger, config.logger, config.http_debug_headers if config.http_debug
 
       # Adapter
-      c.use Faraday::Adapter::NetHttp
+      c.adapter Faraday.default_adapter
     end
 
     return api
   end
 
+  # Returns the app module for the given app name.
+  #
+  # @param app_name [String, Symbol] the app name
+  # @return [Module] the app module
+  def self.app_module(app_name)
+    @app_modules[app_name.to_sym]
+  end
+
   # (Re)loads the app modules (usually done by {.setup}).
   #
   # @return [Array<Symbol>] the apps that were loaded
@@ -235,12 +284,4 @@ module LWS
     end
   end
 
-  # Returns the app module for the given app name.
-  #
-  # @param app_name [String, Symbol] the app name
-  # @return [Module] the app module
-  def self.app_module(app_name)
-    @app_modules[app_name.to_sym]
-  end
-
 end # module LWS