dialog-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e372a4430bbd304f323b1bc031d73f16a566ca5
+  data.tar.gz: b6d19f20daac02a080787b8253587ec2dcca9235
+SHA512:
+  metadata.gz: ae426620a85e5b85b96156797de093f379a10a264619245a5b5568023fa151ec073e53b1bbe621b7a79a0e146f328d520bfcf196af4baea2f2ea54f19c84ae9f
+  data.tar.gz: 1c5ea3c74da2304f4d0e7671bf30f10e6695fe0c3438642907812d322ef5e7509911629de132aba3176d9fb2a80a3df92b592e102c13f41d8a4909a25ee7c9a1

data/lib/dialog-api/api/conversation.rb

@@ -0,0 +1,19 @@
+module Dialog
+  module API
+    module Conversation
+
+      # Lists all conversations
+      # @return [Array]
+      def conversations
+        get("b/#{bot_id}/conversations")
+      end
+
+      # Retrieves a conversation
+      # @param id [String]
+      # @return [Hash]
+      def conversation(id)
+        get("b/#{bot_id}/conversations/#{id}")
+      end
+    end
+  end
+end

data/lib/dialog-api/api/interlocutor.rb

@@ -0,0 +1,26 @@
+module Dialog
+  module API
+    module Interlocutor
+
+      # Lists all interlocutors
+      # @return [Array]
+      def interlocutors
+        get("b/#{bot_id}/interlocutors")
+      end
+
+      # Retrieves an interlocutor
+      # @param id [String] Interlocutor Id
+      # @return [Hash]
+      def interlocutor(id)
+        get("b/#{bot_id}/interlocutors#{id}")
+      end
+
+      # Creates an interlocutor
+      # @param attributes [Hash]
+      # @return [Hash]
+      def create_interlocutor(attributes)
+        post("b/#{bot_id}/interlocutors", body: { interlocutor: attributes })
+      end
+    end
+  end
+end

data/lib/dialog-api/api/message.rb

@@ -0,0 +1,21 @@
+module Dialog
+  module API
+    module Message
+
+      # Lists all messages associated to a conversation
+      # @param conversation_id [String]
+      # @return
+      def messages(conversation_id)
+        get("b/#{bot_id}/conversations/#{conversation_id}/messages")
+      end
+
+      # Retrieves a message
+      # @param id [String]
+      # @param conversation_id [String]
+      # @return
+      def message(id, conversation_id)
+        get("b/#{bot_id}/conversations/#{conversation_id}/messages/#{id}")
+      end
+    end
+  end
+end

data/lib/dialog-api/api/track.rb

@@ -0,0 +1,29 @@
+module Dialog
+  module API
+    module Track
+
+      # Tracks a message
+      # @param payload [Hash]
+      # @return
+      def track(payload)
+        body = {
+          message: {
+            conversation_distinct_id: payload[:conversation_distinct_id],
+            creator_distinct_id: payload[:creator_distinct_id],
+            creator_type: payload[:creator_type],
+            distinct_id: payload[:distinct_id],
+            platform: payload[:platform],
+            provider: payload[:provider],
+            mtype: payload[:mtype],
+            sent_at: payload[:sent_at],
+            properties: {
+              text: payload[:text]
+            }
+          }
+        }
+
+        post("b/#{bot_id}/track", body: body)
+      end
+    end
+  end
+end

data/lib/dialog-api/client.rb

@@ -0,0 +1,34 @@
+require 'dialog-api/request'
+require 'dialog-api/api/conversation'
+require 'dialog-api/api/interlocutor'
+require 'dialog-api/api/message'
+require 'dialog-api/api/track'
+
+module Dialog
+  class Client
+    include Dialog::Request
+    include Dialog::API::Conversation
+    include Dialog::API::Interlocutor
+    include Dialog::API::Message
+    include Dialog::API::Track
+
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # @param options [Hash]
+    def initialize(options = {})
+      options = Dialog.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    # Wraps an url into a trackable Dialog url
+    # @param id [String] A conversation distinct Id provided by the platform or the provider
+    # @param url [String]
+    # @return [String]
+    def link(id, url)
+      escaped = URI.escape(url, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      URI.join(api_endpoint, "v1/click/", id, "?url=#{escaped}").to_s
+    end
+  end
+end

data/lib/dialog-api/configuration.rb

@@ -0,0 +1,36 @@
+require 'dialog-api/version'
+
+module Dialog
+  module Configuration
+    VALID_OPTIONS_KEYS    = [:api_endpoint, :api_token, :user_agent, :bot_id, :on_error].freeze
+
+    DEFAULT_API_ENDPOINT  = "https://api.dialoganalytics.com/v1/"
+    DEFAULT_API_TOKEN     = nil
+    DEFAULT_USER_AGENT    = "Dialog Ruby Gem #{Dialog::VERSION}".freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset!
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[ * VALID_OPTIONS_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+
+    def reset!
+      self.api_endpoint = DEFAULT_API_ENDPOINT
+      self.api_token    = DEFAULT_API_TOKEN
+      self.user_agent   = DEFAULT_USER_AGENT
+      self.on_error     = Proc.new {}
+      self.bot_id       = nil
+
+      return true
+    end
+  end
+end

data/lib/dialog-api/request.rb

@@ -0,0 +1,55 @@
+require 'http'
+
+module Dialog
+  module Request
+
+    # Performs a HTTP Get request
+    #
+    # @param path [String]
+    # @param params [Hash]
+    def get(path, params: {})
+      request(:get, URI.parse(api_endpoint).merge(path), params: params)
+    end
+
+    # Performs a HTTP Post request
+    #
+    # @param path [String]
+    # @param params [Hash]
+    # @param body [Hash]
+    def post(path, params: {}, body: {})
+      request(:post, URI.parse(api_endpoint).merge(path), params: params, body: body)
+    end
+
+
+    private
+
+    # @return [HTTP::Client]
+    # @raise [ArgumentError]
+    def request(method, path, params: {}, body: {})
+      raise ArgumentError, ("Please configure Dialog.api_token first") unless api_token
+      raise ArgumentError, ("Please configure Dialog.bot_id first") unless bot_id
+
+      headers = {
+        'accept' => "application/json",
+        'User-Agent' => Dialog.user_agent,
+        'Authorization' => "Api-Key #{api_token}"
+      }
+
+      response = Http.headers(headers).send(method, path, params: params, json: body)
+
+      # Pass on errors when HTTP status included in 400 to 599
+      if (400..599).include?(response.code)
+        begin
+          body = response.parse['error']
+        rescue HTTP::Error
+          body = nil
+        end
+
+        on_error.call(response.code, response.reason, body)
+      end
+
+      # Return parsed json body
+      response.parse
+    end
+  end
+end

data/lib/dialog-api/version.rb

@@ -0,0 +1,3 @@
+module Dialog
+  VERSION = "0.0.2"
+end

data/lib/dialog-api.rb

@@ -0,0 +1,14 @@
+require 'dialog-api/configuration'
+require 'dialog-api/client'
+
+module Dialog
+  extend Configuration
+
+  # Alias for Dialog::Client.new
+  #
+  # @return [Dialog::Client]
+  def new(options = {})
+    Dialog::Client.new(options)
+  end
+  module_function :new
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: dialog-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Philippe Dionne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Dialog is a conversational analytics platform. See https://dialoganalytics.com
+  for details.
+email:
+- p@dialoganalytics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dialog-api.rb
+- lib/dialog-api/api/conversation.rb
+- lib/dialog-api/api/interlocutor.rb
+- lib/dialog-api/api/message.rb
+- lib/dialog-api/api/track.rb
+- lib/dialog-api/client.rb
+- lib/dialog-api/configuration.rb
+- lib/dialog-api/request.rb
+- lib/dialog-api/version.rb
+homepage: https://github.com/dialoganalytics/dialog-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: A ruby client for the Dialog API.
+test_files: []