groovehq 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5297d2c40416cd886269a0843c1fb532d23c25c6
-  data.tar.gz: bec7bed50a2eb6e43dd9186de38757bee6a23dce
+  metadata.gz: 43f043143339184bc705dda2e5fa561531a5c010
+  data.tar.gz: d0a3a58f8a05e824e43b49a0c2614d085814ef5f
 SHA512:
-  metadata.gz: 951ce20a379d848d1cfffbfd32d1585e7ee4d74f9693de5b04b3389f411c35ccf37c37af71822805c0a52a48034344ea4e55a7ec0d47c328ccfce6e67e89206a
-  data.tar.gz: c0aea7da762427a4f8851e7a2904f03ba8c38a4087b7972574ac9eee1f6e06a81d6ddb357e63d1a9e2231c82bdf8a0d1eeeae135e6faf07efbaaeffbae653772
+  metadata.gz: c049b74da9379131aa2e86f4a40c30096a29ee2492e73bb0b09330b10b226df377fbcd0b27e8629ad402854fbe511fc6ceda7408e724c6665aa1486baf754321
+  data.tar.gz: 796ae8ac97aebf7902d6750577e34dc96426278131fce0790d1b75ab3d4d945e2077466308ed798784d9a662bd87dc955a30c0562bf70edbdf4396aec2fa6e8f

data/README.md

@@ -1,3 +1,55 @@
 ### GrooveHQ ruby client library
 
 [![Build Status](https://travis-ci.org/Fodoj/groovehq.svg)](https://travis-ci.org/Fodoj/groovehq)
+
+Client library for talking to [GrooveHQ API](https://www.groovehq.com/docs). Supports all endpoints, as well as chaining API requests for hypermedia links.
+
+#### Usage
+
+First of all, initialize client:
+
+```ruby
+client = GrooveHQ::Client.new("MY_API_TOKEN")
+```
+
+And then talk to API:
+
+```ruby
+client.tickets(page: 2).first.number
+```
+
+#### Hypermedia support
+
+Gem supports hypermedia links and allows to chain unlimited amount of requests like this:
+
+```ruby
+client.tickets(page: 2).rels[:next].get.first.rels[:customer].get.email
+```
+
+#### List of all methods
+
+Client methods really just map 1 to 1 to API, see all of them beyond. Check API docs for list of available `options`.
+
+```ruby
+agent(email)
+agents(options = {})
+update_customer(options = {})
+customer(email)
+customers(options = {})
+folders(options = {})
+groups(options = {})
+mailboxes(options = {})
+create_message(options)
+message(message_id)
+messages(ticket_number, options = {})
+tickets_count(options = {})
+create_ticket(options)
+ticket(ticket_number)
+tickets(options = {})
+ticket_state(ticket_number)
+update_ticket_state(ticket_number, state)
+ticket_assignee(ticket_number)
+update_ticket_assignee(ticket_number, assignee)
+update_ticket_priority(ticket_number, priority)
+update_ticket_assigned_group(ticket_number, assigned_group)
+```

data/groovehq.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'groovehq/version'
@@ -17,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.0'
 
   spec.add_dependency "httparty"
   spec.add_dependency "activesupport"

data/lib/groovehq/client/folders.rb

@@ -3,7 +3,6 @@ module GrooveHQ
 
     module Folders
 
-      # Doesn't work, waiting for GrooveHQ team to clarify
       def folders(options = {})
         get("/folders", options)
       end

data/lib/groovehq/client/tickets.rb

@@ -3,7 +3,6 @@ module GrooveHQ
 
     module Tickets
 
-      # FIXME Doesn't work yet, shows only one random folder at the moment
       def tickets_count(options = {})
         get("/tickets/count", options)
       end

data/lib/groovehq/resource_collection.rb

@@ -7,6 +7,8 @@ module GrooveHQ
       data = {} unless data.is_a?(Hash)
       data = data.with_indifferent_access
 
+      @client = client
+
       meta_data = data.delete(:meta) { Hash.new }
 
       collection = Array(data.values.first).map do |item|
@@ -18,10 +20,10 @@ module GrooveHQ
       if meta_data.has_key?("pagination")
         links = {
           next: {
-            href: meta_data["pagination"]["next_page"]
+            "href" => meta_data["pagination"]["next_page"]
           },
           prev: {
-            href: meta_data["pagination"]["prev_page"]
+            "href" => meta_data["pagination"]["prev_page"]
           }
         }
       end

data/lib/groovehq/version.rb

@@ -1,3 +1,3 @@
 module GrooveHQ
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groovehq
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Kirill Shirinkin
@@ -111,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="