girlscout 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de5ee14889bf953e416b87030e72390494e1d054d3741bda1583cdafdb233577
-  data.tar.gz: 7b462a2aedf9b630ceee7c602e42fa81015218b005afc3242f2c85b22e30a48d
+  metadata.gz: e813cb84802b26b3db2298227a8414b2a14de4a6bec0b5538f6163d2ad6ae1d1
+  data.tar.gz: 5b1737b3c525b5193711848eaddd19056dfff7a77c7ab63fddc3f7b4765d99de
 SHA512:
-  metadata.gz: a4871a86d2ef4c2bb7952966553c90b79f36ab1a2467e9da120bea156a5c30ac08c23f609ce5fd27426d6f434aac9cc96c7ace9998fa6cefaebfca8011cea58a
-  data.tar.gz: ad3eac246d498eedf109bbb024c28b97982215055d1e31b247e92a6df08462ccbc08d8d2c6114fc24ee4a94c90cb21c0cace29c9be9f249b1f47167dae7ab1e7
+  metadata.gz: e8f78b1ae310eeba7b0ecfc15e075e07edf297e778eb93eeef67ef83792b0e4d7afd304802d2bf4054ed172c851fd611d90fdb24370c0744a42df3226109df35
+  data.tar.gz: f2b7e5ac9f9702f8b26d49aa90592580b9817cba14dbf075b8ba031871da55b03a2e2b8652bdd9f0a51c44ee89054ddaab9569ced48dff732b072306d1720e96

data/lib/girlscout.rb

@@ -2,6 +2,7 @@
 
 require 'excon'
 
+require 'girlscout/version'
 require 'girlscout/resource'
 require 'girlscout/config'
 
@@ -10,6 +11,7 @@ require 'girlscout/concerns/has_resource'
 require 'girlscout/object'
 require 'girlscout/error'
 
+require 'girlscout/access_token'
 require 'girlscout/list'
 require 'girlscout/folder'
 require 'girlscout/mailbox'
@@ -18,4 +20,3 @@ require 'girlscout/attachment'
 require 'girlscout/thread'
 require 'girlscout/customer'
 require 'girlscout/user'
-require 'girlscout/search'

data/lib/girlscout/access_token.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module GirlScout
+  class AccessToken
+    include GirlScout::Concerns::HasAttributes
+
+    attr_reader :expires_at
+
+    class << self
+      def refresh
+        response = Excon.post(
+          "#{Config.api_prefix}/oauth2/token",
+          body: credential,
+          headers: { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        )
+        raise GirlScout::Error, JSON.parse(response.body) if response.status >= 400
+
+        new(JSON.parse(response.body))
+      end
+
+      private
+
+      def credential
+        URI.encode_www_form(
+          client_id: Config.client_id,
+          client_secret: Config.client_secret,
+          grant_type: 'client_credentials'
+        )
+      end
+    end
+
+    def initialize(attr = {})
+      @attributes = normalize_attributes(attr)
+      @expires_at = Time.now + expires_in
+    end
+
+    def expired?
+      @expires_at.to_i <= Time.now.to_i
+    end
+
+    def to_s
+      access_token
+    end
+  end
+end

data/lib/girlscout/concerns/has_resource.rb

@@ -13,23 +13,19 @@ module GirlScout
         @resource ||= build_resource
       end
 
-      def resource_path
-        return self.class.resource_path if self.class.respond_to?(:resource_path)
-        @path
-      end
-
       def resource_url
-        "#{GirlScout::Config.api_prefix}#{@path}"
+        "#{GirlScout::Config.api_prefix}#{@endpoint}"
       end
 
       def endpoint(path)
-        @path = path
+        @endpoint = path
       end
 
       private
 
       def build_resource
         return self.class.resource if self.class.respond_to?(:resource)
+
         Resource.new(url: resource_url)
       end
     end

data/lib/girlscout/config.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module GirlScout
-  DEFAULT_API_PREFIX = 'https://api.helpscout.net/v1'
+  DEFAULT_API_PREFIX = 'https://api.helpscout.net/v2'
 
   class Config
     class << self
-      attr_accessor :api_key
+      attr_accessor :client_id, :client_secret
       attr_writer :api_prefix
 
       def api_prefix
@@ -13,7 +13,8 @@ module GirlScout
       end
 
       def reset!
-        @api_key = nil
+        @client_id = nil
+        @client_secret = nil
         @api_prefix = DEFAULT_API_PREFIX
       end
     end

data/lib/girlscout/conversation.rb

@@ -6,35 +6,56 @@ module GirlScout
 
     class << self
       def find(id)
-        Conversation.new(resource["/#{id}"].get['item'])
+        Conversation.new(resource["/#{id}"].get)
+      end
+
+      def list(query = {})
+        List.new(resource.get(query: query), Conversation)
       end
 
       def create(attributes)
         attributes = attributes.as_json if attributes.respond_to?(:as_json)
-        attributes['reload'] ||= true
-        Conversation.new(resource.post(payload: attributes)['item'])
+        resource.post(payload: attributes)
       end
     end
 
     def customer
-      @customer ||= Customer.new(self['customer'] || {})
+      @customer ||= Customer.new(self['customer'] || self['primary_customer'] || {})
     end
 
     def threads
-      @threads ||= (self['threads'] || []).map { |attr| Thread.new(attr) }
+      # `threads` is a number in response but must be an array in request payload.
+      @threads ||= begin
+        if self['threads'].is_a?(Array)
+          (self['threads'] || []).map { |attr| Thread.new(attr) }
+        else
+          List.new(threads_resouce.get, Thread)
+        end
+      end
     end
 
     def mailbox
-      @mailbox ||= Mailbox.new(self['mailbox'] || {})
+      @mailbox ||= begin
+        if self['mailbox'].is_a?(Hash)
+          Mailbox.new(self['mailbox'] || {})
+        else
+          Mailbox.new(Resource.new(url: self['Links']['mailbox']['href']).get)
+        end
+      end
     end
 
     def as_json
-      # TODO: Test
-      json = super.dup
+      json = super
       json['customer'] = customer.as_json if key?('customer')
       json['threads'] = threads.map(&:as_json) if key?('threads')
       json['mailbox'] = mailbox.as_json if key?('mailbox')
       json
     end
+
+    private
+
+    def threads_resouce
+      @threads_resouce ||= Resource.new(url: self['Links']['threads']['href'])
+    end
   end
 end

data/lib/girlscout/customer.rb

@@ -5,19 +5,13 @@ module GirlScout
     endpoint '/customers'
 
     class << self
-      def all
-        List.new(resource.get, Customer)
-      end
-
       def find(id)
-        Customer.new(resource["/#{id}"].get['item'])
+        Customer.new(resource["/#{id}"].get)
       end
-    end
 
-    def as_json
-      json = super
-      json['type'] = 'customer'
-      json
+      def list(query = {})
+        List.new(resource.get(query: query), Customer)
+      end
     end
   end
 end

data/lib/girlscout/error.rb

@@ -6,7 +6,7 @@ module GirlScout
 
     def initialize(attr = {})
       @attributes = normalize_attributes(attr)
-      super @attributes['error']
+      super @attributes['message']
     end
   end
 end

data/lib/girlscout/list.rb

@@ -14,7 +14,7 @@ module GirlScout
     end
 
     def items
-      @items ||= (@attributes['items'] || []).map do |attr|
+      @items ||= (embedded_items || []).map do |attr|
         @item_class.new(attr)
       end
     end
@@ -26,5 +26,11 @@ module GirlScout
     def each(&block)
       items.each(&block)
     end
+
+    private
+
+    def embedded_items
+      @embedded_items ||= @attributes['Embedded'].values[0]
+    end
   end
 end

data/lib/girlscout/mailbox.rb

@@ -5,47 +5,17 @@ module GirlScout
     endpoint '/mailboxes'
 
     class << self
-      def all
-        List.new(resource.get, Mailbox)
+      def find(id)
+        Mailbox.new(resource["/#{id}"].get)
       end
 
-      def find(id)
-        Mailbox.new(resource["/#{id}"].get['item'])
+      def list
+        List.new(resource.get, Mailbox)
       end
     end
 
     def folders
-      @folders ||= List.new(folder_resource.get, Folder)
-    end
-
-    def conversations
-      @conversations ||= List.new(conversation_resource.get, Conversation)
-    end
-
-    def users
-      @users ||= List.new(user_resource.get, User)
-    end
-
-    def customers
-      @customers ||= List.new(customer_resource.get, Customer)
-    end
-
-    protected
-
-    def folder_resource
-      @folder_resource ||= resource["/#{id}/folders"]
-    end
-
-    def conversation_resource
-      @conversation_resource ||= resource["/#{id}/conversations"]
-    end
-
-    def user_resource
-      @user_resource ||= resource["/#{id}/users"]
-    end
-
-    def customer_resource
-      @customer_resource ||= resource["/#{id}/customers"]
+      @folders ||= List.new(resource["/#{id}/folders"].get, Folder)
     end
   end
 end

data/lib/girlscout/resource.rb

@@ -6,12 +6,11 @@ module GirlScout
   class Resource
     METHODS = %i[get put post patch delete].freeze
 
+    attr_accessor :url
+
     def initialize(url: '')
       @url = url
-    end
-
-    def url
-      "#{@url}.json"
+      @access_token = AccessToken.refresh
     end
 
     def [](path)
@@ -21,25 +20,41 @@ module GirlScout
     METHODS.each do |method|
       define_method(method) do |payload: nil, query: nil|
         options = { method: method }
-        if payload
-          options[:body] = JSON.generate(payload)
-          options[:headers] ||= {}
-          options[:headers]['Content-Type'] = 'application/json'
-        end
-        options[:query] = query if query
+        options[:headers] = {
+          'Content-Type' => 'application/json; charset=UTF-8',
+          'Authorization' => "Bearer #{access_token}"
+        }
+        options[:body] = JSON.generate(payload) if payload
+        options[:query] = URI.encode_www_form(query) if query
 
         request(options)
       end
     end
 
+    private
+
+    def access_token
+      @access_token = AccessToken.refresh if @access_token&.expired?
+      @access_token
+    end
+
     def request(options = {})
-      auth = { user: Config.api_key, password: 'X' }
-      response = Excon.new(url, auth).request(options)
-      if response.status >= 400 && response.status < 600
-        raise GirlScout::Error, JSON.parse(response.body)
+      response = Excon.new(@url).request(options)
+      case response.status
+      when 200
+        JSON.parse(response.body)
+      when 201
+        response.headers['Resource-ID']
+      else
+        raise GirlScout::Error, message: error_message(response.body), code: response.status
       end
+    end
 
-      JSON.parse(response.body)
+    def error_message(body)
+      body = JSON.parse(body)
+      body['message'] || body['error_description']
+    rescue JSON::ParserError
+      body
     end
   end
 end

data/lib/girlscout/thread.rb

@@ -3,27 +3,18 @@
 module GirlScout
   class Thread < GirlScout::Object
     def attachments
-      @attachments ||= (self['attachments'] || []).map do |attr|
+      @attachments ||= (self['Embedded']['attachments'] || []).map do |attr|
         Attachment.new(attr)
       end
     end
 
-    def created_by
-      @created_by = nil unless defined? @created_by
-      return @created_by if @created_by
-
-      attr = @attributes['createdBy']
-      creator_type = begin
-                       "GirlScout::#{attr['type'].capitalize}".constantize
-                     rescue StandardError
-                       User
-                     end
-      @created_by ||= creator_type.new(attr)
+    def customer
+      @customer ||= Customer.new(self['customer'] || {})
     end
 
     def as_json
       json = super
-      json['createdBy'] = created_by.as_json if key?('created_by')
+      json['customer'] = customer.as_json if key?('customer')
       json
     end
   end

data/lib/girlscout/user.rb

@@ -5,12 +5,12 @@ module GirlScout
     endpoint '/users'
 
     class << self
-      def all
-        List.new(resource.get, User)
+      def find(id)
+        User.new(resource["/#{id}"].get)
       end
 
-      def find(id)
-        User.new(resource["/#{id}"].get['item'])
+      def list(query = {})
+        List.new(resource.get(query: query), User)
       end
 
       def me

data/lib/girlscout/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GirlScout
+  VERSION = '0.5.0'
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: girlscout
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
-- Chakrit Wichian
+- Phureewat Aphibansri <phureewat@omise.co>
+- Chakrit Wichian <chakrit@omise.co>
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -30,28 +31,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -170,21 +171,22 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-description: Provides integration with HelpScout REST API.
-email: chakrit@omise.co
+        version: '5.0'
+description: Provides integration with HelpScout REST API v2
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/girlscout.rb
+- lib/girlscout/access_token.rb
 - lib/girlscout/attachment.rb
 - lib/girlscout/concerns/has_attributes.rb
 - lib/girlscout/concerns/has_resource.rb
@@ -197,10 +199,10 @@ files:
 - lib/girlscout/mailbox.rb
 - lib/girlscout/object.rb
 - lib/girlscout/resource.rb
-- lib/girlscout/search.rb
 - lib/girlscout/thread.rb
 - lib/girlscout/user.rb
-homepage: https://www.omise.co
+- lib/girlscout/version.rb
+homepage: https://github.com/omise/girlscout
 licenses:
 - MIT
 metadata: {}
@@ -220,8 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Integrate your support tooling with HelpScout API.
+summary: Integrate your support tooling with HelpScout API v2
 test_files: []

data/lib/girlscout/search.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module GirlScout
-  class Search < GirlScout::Object
-    endpoint '/search'
-
-    class << self
-      def conversations(query)
-        search(Conversation, query)
-      end
-
-      def customers(query)
-        search(Customer, query)
-      end
-
-      private
-
-      def search(klass, query)
-        result = resource[klass.resource_path].get(query: { query: query })
-        List.new(result, klass)
-      end
-    end
-  end
-end