vimaly 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d14adbbb6cfb6bcd28a369de71608726014a378b
-  data.tar.gz: bcc970b7e562eed22ae9b180a1e9737aa2bf103d
+SHA256:
+  metadata.gz: 42d7553c8960f23093c3fd2deafc378f7970fc0b62d35ceafc94b42a0473c970
+  data.tar.gz: a8ddca4b4d5421ad916b69d11e9d69e1fb48fe0b1bdca933ff70162a56d170f3
 SHA512:
-  metadata.gz: 6b422a4e99ebb3dc15fc35bf4ef43c90c85582d951ee335cfd1069c35a184c0c741801e9b211125caedcc855fb3bb794343dda60dae0bf9d0780cdee727c9a51
-  data.tar.gz: d2c65390339e2c1791865126c9951d484cedfe6a4bae5c5bfb55acaaa65020a90a1b02628e9bcf0cd5c11e9bafae2b24b9fa4a7b8729e6206c35c29f4bee1b60
+  metadata.gz: 0dd8df6c3e2fe09a36ff2be2f48ed21a2d8a7338cf69e4c17b407c5a51af0828bb5ec1c072bc1886a853b6fa8e4c551e3fa708b9f11cc6c60a984e90bcf2dd98
+  data.tar.gz: a593b96cd95a00e11712080109af2d9e35668ee2cdaeafc833f8703eb8647a374ded79ff97413c9af9b286d7b7df0fa4e2111ca6897a4d0a3cd4fb6a7b0219f0

data/.gitignore

@@ -7,7 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-.ruby-version
 .ruby-gemset
 /_ignore
 .idea/

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -1,5 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.12.5
+  - 2.5.3
+  - 2.6.3
+before_install: gem install bundler

data/CHANGELOG.md

@@ -1,12 +1,71 @@
 # CHANGELOG
 
-## 0.1.0 (not yet released)
+## 1.1.0
 
- * initial copy from the `investapp`
+* add support for searching tickets [#19](https://github.com/sharesight/vimaly/pull/19)
+
+## 1.0.2
+
+* Fix unfriendly filenames not attaching to Vimaly tickets [#17](https://github.com/sharesight/vimaly/pull/17)
+
+## 1.0.1
+
+* Update for Ruby 2.6.3 compatibility.
+
+## 1.0.0
+
+ * allow adding attachments with providing a content-type [#15](https://github.com/sharesight/vimaly/pull/15)
+
+## 0.5.3
+
+ * add support for Ruby `2.5.3` [#14](https://github.com/sharesight/vimaly/pull/14)
+
+## 0.5.2
+
+ * return the correct ticket-id after creating a ticket [#13](https://github.com/sharesight/vimaly/pull/13)
+
+## 0.5.1
+
+ * return the ticket-id after updating a ticket [#12](https://github.com/sharesight/vimaly/pull/12)
+
+## 0.5.0
+
+ * add support for adding attachments to tickets [#11](https://github.com/sharesight/vimaly/pull/11)
+
+## 0.4.0
+
+ * support API version 2 [#10](https://github.com/sharesight/vimaly/pull/10)
+
+## 0.3.1
+
+ * use Ruby `2.5.1` [#9](https://github.com/sharesight/vimaly/pull/9)
+
+## 0.3.0
+
+ * ask for more bins [#8](https://github.com/sharesight/vimaly/pull/8)
+
+## 0.2.5
+
+ * Ruby 2.5.0 support
+
+## 0.2.4
+
+ * Ruby 2.4.2 support
+
+ ## 0.2.3
+
+  * Ruby 2.4.1 support
+
+## 0.2.2
+
+ * handle Bad Gateway 502 errors
+
+## 0.2.1
+
+ * Fix creation of duplicated tickets (due to caching)
 
 ## 0.2.0
 
  * Support the ability to retrieve all tickets for a bin, and to run a matcher through this
  * Support custom fields on ticket
  * Add an integration test (site configured)
- 

data/lib/vimaly.rb

@@ -1,4 +1,5 @@
 require_relative "vimaly/version"
+require_relative "vimaly/exceptions"
 require_relative "vimaly/bin"
 require_relative "vimaly/ticket_type"
 require_relative "vimaly/ticket"

data/lib/vimaly/client.rb

@@ -8,10 +8,10 @@ module Vimaly
     VIMALY_ROOT_URL = "https://o1.vimaly.com"
     CUSTOM_FIELD_TYPES = [::NilClass, ::String, ::Float, ::Integer, ::Array, ::Date]
 
-    def initialize(company_id, username, password, logger=nil)
+    def initialize(company_id, user_credentials: nil, auth_key: nil, logger: nil)
       @company_id = company_id
-      @username = username
-      @password = password
+      @user_credentials = user_credentials
+      @auth_key = auth_key
       @logger = logger
 
       @bin_tickets = {}
@@ -27,11 +27,12 @@ module Vimaly
         merge(others)
       )
 
+      ticket_id = next_ticket_id
       ticket_to_json = ticket.to_json(custom_field_name_map)
-      response = post("/tickets/#{next_ticket_id}", ticket_to_json)
+      response = post("/tickets/#{ticket_id}", ticket_to_json)
       case response.status
       when 200..299
-        true
+        ticket_id
       else
         log_warn "status: #{response.status}"
         log_warn "        #{response.inspect}"
@@ -44,12 +45,33 @@ module Vimaly
 
       response = put("/tickets/#{id}", ticket.to_json(custom_field_name_map, true))
       case response.status
-        when 200..299
-          true
-        else
-          log_warn "status: #{response.status}"
-          log_warn "        #{response.inspect}"
-          false
+      when 200..299
+        id
+      else
+        log_warn "status: #{response.status}"
+        log_warn "        #{response.inspect}"
+        false
+      end
+    end
+
+    def search_tickets(query_string, state: 'active')
+      ticket_type_map = Hash[ticket_types.map { |t| [t.id, t] }]
+      bin_map = Hash[bins.map { |b| [b.id, b] }]
+
+      get("/ticket-search?text=#{query_string}&state=#{state}").map do |ticket_data|
+        Ticket.from_vimaly(ticket_data, ticket_type_map, bin_map, custom_fields)
+      end
+    end
+
+    def add_attachment(ticket_id, file_name, file_content, request_options={})
+      response = post("/tickets/#{ticket_id}/attachments?name=#{CGI.escape(file_name)}", file_content, request_options)
+      case response.status
+      when 200..299
+        true
+      else
+        log_warn "status: #{response.status}"
+        log_warn "        #{response.inspect}"
+        false
       end
     end
 
@@ -64,7 +86,7 @@ module Vimaly
 
     def bins
       @bins ||= begin
-        get('/bins').map do |bin_data|
+        get('/bins?max-results=500').map do |bin_data|
           Bin.new(bin_data['_id'], bin_data['name'])
         end
       end
@@ -97,10 +119,8 @@ module Vimaly
       ticket_type_map = Hash[ticket_types.map { |t| [t.id, t] }]
       bin_map = Hash[bins.map { |b| [b.id, b] }]
 
-      @bin_tickets[bin_id] ||= begin
-        get("/tickets?bin_id=#{bin_id}").map do |ticket_data|
-          Ticket.from_vimaly(ticket_data, ticket_type_map, bin_map, custom_fields)
-        end
+      get("/tickets?bin_id=#{bin_id}").map do |ticket_data|
+        Ticket.from_vimaly(ticket_data, ticket_type_map, bin_map, custom_fields)
       end
     end
 
@@ -140,34 +160,40 @@ module Vimaly
     end
 
     def get(api_path)
-      response = faraday.get("/rest/1/#{@company_id}#{api_path}") do |request|
-        request.headers.update({ accept: 'application/json', content_type: 'application/json' })
+      response = faraday.get("/rest/2/#{@company_id}#{api_path}") do |request|
+        update_request_headers(request)
       end
       unless response.success?
-        raise("Vimaly #{api_path} call failed")
+        raise Vimaly::ConnectionError.new("Vimaly #{api_path} call failed with response #{response.status}")
       end
       JSON.parse(response.body)
     end
 
-    def post(api_path, json)
-      faraday.post("/rest/1/#{@company_id}#{api_path}", json) do |request|
-        request.headers.update({ accept: 'application/json', content_type: 'application/json' })
+    def post(api_path, content, headers={})
+      faraday.post("/rest/2/#{@company_id}#{api_path}", content) do |request|
+        update_request_headers(request, headers)
       end
     end
 
     def put(api_path, json)
-      faraday.put("/rest/1/#{@company_id}#{api_path}", json) do |request|
-        request.headers.update({ accept: 'application/json', content_type: 'application/json' })
+      faraday.put("/rest/2/#{@company_id}#{api_path}", json) do |request|
+        update_request_headers(request)
       end
     end
 
     def faraday
       @faraday ||= Faraday.new(VIMALY_ROOT_URL).tap do |connection|
-        connection.basic_auth(@username, @password)
+        connection.basic_auth(@user_credentials[:username], @user_credentials[:password]) if @user_credentials
         connection.request(:json)
       end
     end
 
+    def update_request_headers(request, headers={})
+      request.headers.update({ accept: 'application/json', content_type: 'application/json' })
+      request.headers.update({ authorization: "bearer #{@auth_key}" }) if @auth_key
+      request.headers.update(headers)
+    end
+
     def log_warn(s)
       @logger.warn(s) if @logger
     end

data/lib/vimaly/exceptions.rb

@@ -0,0 +1,3 @@
+module Vimaly
+  class ConnectionError < RuntimeError; end
+end

data/lib/vimaly/ticket.rb

@@ -1,12 +1,14 @@
+require "active_support/core_ext/hash/indifferent_access"
+
 module Vimaly
   class Ticket
 
     # title, description, format, ticket_type, bin, id=nil
     def initialize(*params)
       if params.first.is_a?(Hash)
-        @ticket_fields = params.first
+        @ticket_fields = HashWithIndifferentAccess.new(params.first)
       else
-        @ticket_fields = {}
+        @ticket_fields = HashWithIndifferentAccess.new
         [:title, :description, :format, :ticket_type, :bin, :id].each_with_index do |param_key, idx|
           break if idx>=params.size
           @ticket_fields[param_key] = params[idx]
@@ -44,19 +46,22 @@ module Vimaly
     def to_vimaly(custom_field_name_map, for_update=false)
       vimaly_fields = Hash[@ticket_fields.map do |field_name, field_value|
         case(field_name)
-          when :format
+          when 'id'
+            nil   # id should not be in ticket body
+          when 'format'
             ['rtformat', field_value]
-          when :title
+          when 'title'
             ['name', field_value]
-          when :description
+          when 'description'
             ['description', normalise(field_value)]
-          when :ticket_type
+          when 'ticket_type'
             ['ticketType_id', field_value.id]
-          when :bin
+          when 'bin'
             ['bin_id', field_value.id]
           else
             if for_update
-              fdef = custom_field_name_map[field_name.to_s]
+              fdef = custom_field_name_map[field_name]
+              raise "Field type #{field_name} is not a defined custom or standard field in Vimaly" unless fdef
               ["customFields.#{fdef[:id]}", cast_to_vimaly(field_value, fdef[:type])]
             else
               nil
@@ -66,7 +71,7 @@ module Vimaly
       ]
 
       unless for_update
-        custom_fields = @ticket_fields.select {|fn, _v| ![:format, :title, :description, :ticket_type, :bin].include?(fn) }
+        custom_fields = @ticket_fields.select {|fn, _v| ![:format, :title, :description, :ticket_type, :bin].include?(fn.to_sym) }
         if custom_fields && !custom_fields.empty?
           vimaly_fields['customFields'] =
             Hash[custom_fields.map do |field_name, field_value|
@@ -98,6 +103,11 @@ module Vimaly
       to_vimaly(custom_field_name_map, for_update).to_json
     end
 
+    def add_id(id)
+      raise "Ticket already has id #{@ticket_fields[:'_id']} and we try and add #{id}" if @ticket_fields[:'_id']
+      @ticket_fields['_id'] = id
+    end
+
     def [](name)
       @ticket_fields[name]
     end
@@ -108,6 +118,10 @@ module Vimaly
       super
     end
 
+    def update_fields(fields)
+      @ticket_fields.merge!(fields)
+    end
+
     private
 
     def normalise(text)

data/lib/vimaly/version.rb

@@ -1,3 +1,3 @@
 module Vimaly
-  VERSION = "0.2.0"
+  VERSION = "1.1.0".freeze
 end

data/vimaly.gemspec

@@ -21,9 +21,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday"
   spec.add_dependency "faraday_middleware"
+  spec.add_dependency "activesupport"
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "maxitest", '~> 1'
   spec.add_development_dependency "shoulda-context"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimaly
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Thorsten Boettger
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-02-14 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,34 +38,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -142,6 +157,7 @@ files:
 - lib/vimaly.rb
 - lib/vimaly/bin.rb
 - lib/vimaly/client.rb
+- lib/vimaly/exceptions.rb
 - lib/vimaly/ticket.rb
 - lib/vimaly/ticket_type.rb
 - lib/vimaly/version.rb
@@ -150,7 +166,7 @@ homepage: https://github.com/sharesight/vimaly
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,9 +181,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Wrapper for the Vimaly API
 test_files: []