vimaly 1.0.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d72a2025b7696e9d5282376e74beed0a99a089b9714cd9469bf93c0a4c636d39
-  data.tar.gz: 7f27cc5960df434c36e292c7e61fc0723d5306d12601b8c628ed75033c024fbf
+  metadata.gz: 2fbe16192cd230b1bc9195d5ef9f8faea9c0bdd99041be3b04abf87fb26f27e6
+  data.tar.gz: 713fa776cc88c0cf8b37dcbeae00cc4a3faabc5da76e17ad36c1e4cfd37fe385
 SHA512:
-  metadata.gz: efb54c0796cead3eec74b605aaf6106ecb612c2e9ff2442a57abe135264ee4cb9d9ee3bc7fddb692790c36f9e25e4549335ae69375028b99f68c1eacb946003b
-  data.tar.gz: ea232fd63fa12c2cec8b52547a3741a7a8f760900ad8768ad6e889300055443a8a3b50a80806d6a02c1c3fad52fa33adcdee409d895bf3582cc159508d3df15a
+  metadata.gz: f68b2e105cf61343ac2d2eb452ac3bb1b427deef775fc0d31b9a327839debe8a403a2c37780bd013275b16b8b70fde7be07a2211ba2ce12b670a99711b05c416
+  data.tar.gz: c50e2bb91e042557c69a74a608c6625898b6272359822e4c10e846e86aaad959e1d408d3babcc194e6be130c94dd94449703294c7a412c8e0cffd5efdfc9a1e8

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.6.5

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## 1.3.0
+
+* add support for more than 200 results when searching for tickets [#22](https://github.com/sharesight/vimaly/pull/22)
+
+## 1.2.0
+
+* add support for more than 500 bins, refactored and options added [#21](https://github.com/sharesight/vimaly/pull/21)
+
+## 1.1.1
+
+* add support for more than 500 bins [#20](https://github.com/sharesight/vimaly/pull/20)
+
+## 1.1.0
+
+* 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)

data/lib/vimaly/client.rb

@@ -54,6 +54,38 @@ module Vimaly
       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] }]
+
+      tickets = []
+      i = 0
+
+      while (i * 500) <= 5000
+        # Without max-results the request defaults to 200.
+        # The maximum max-results is 500, so will do 10 requests to get our maximum of 5000 tickets.
+        search_response = get("/ticket-search?text=#{query_string}&state=#{state}&max-results=500&page-token=#{i * 500}")
+
+        response_tickets = case search_response
+          when Array
+            search_response.map do |ticket_data|
+              Ticket.from_vimaly(ticket_data, ticket_type_map, bin_map, custom_fields)
+            end
+          when Hash # Will be a hash when only 1 ticket is returned.
+            [Ticket.from_vimaly(search_response, ticket_type_map, bin_map, custom_fields)]
+          else # If reponse is nil then we know we've got all the data
+            break
+        end
+
+        tickets.concat(response_tickets)
+        break if response_tickets.size < 500 # Can finish search because we've returned all there is.
+
+        i += 1
+      end
+
+      tickets
+    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
@@ -75,10 +107,25 @@ module Vimaly
       end
     end
 
-    def bins
+    def bins(options={})
       @bins ||= begin
-        get('/bins?max-results=500').map do |bin_data|
-          Bin.new(bin_data['_id'], bin_data['name'])
+        # 500 is the vimaly limit
+        bins_per_request = options[:bins_per_request] || 500
+        # 5000 is just a random value here; hopefully we never reach this limit
+        max_number_of_bins = options[:max_number_of_bins] || 5000
+
+        bins = []
+        current_page = 0
+        while bins.size < max_number_of_bins
+          # those request parameters are not documented, maybe this gets added at some
+          # point to https://vimaly.com/public/rest-help.html#Bins
+          chunk_of_bins = get("/bins?max-results=#{bins_per_request}&page-token=#{current_page * bins_per_request}")
+          current_page += 1
+          bins += chunk_of_bins
+          break if chunk_of_bins.size < bins_per_request
+        end
+        bins.map do |bin|
+          Bin.new(bin['_id'], bin['name'])
         end
       end
     end
@@ -113,7 +160,6 @@ module Vimaly
       get("/tickets?bin_id=#{bin_id}").map do |ticket_data|
         Ticket.from_vimaly(ticket_data, ticket_type_map, bin_map, custom_fields)
       end
-
     end
 
     def matching_tickets_in_named_bin(bin_name, title_matcher)

data/lib/vimaly/version.rb

@@ -1,3 +1,3 @@
 module Vimaly
-  VERSION = "1.0.2".freeze
+  VERSION = "1.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimaly
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Thorsten Boettger
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -166,7 +166,7 @@ homepage: https://github.com/sharesight/vimaly
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,8 +181,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Wrapper for the Vimaly API
 test_files: []