vimaly 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9096c5aaa8c67a33674de730a6f59333237ab1de
-  data.tar.gz: 8b93b163163beb27266c42f7cf4f5f5d9229186c
+SHA256:
+  metadata.gz: b0a5b2991366fa54ec8d160b894d4393236d24362d8e659b7bdb2222be9001a9
+  data.tar.gz: 200257d646a0a01284c5d26dae3be16c1c3f31e92fb5e3c9704223b00c8584a6
 SHA512:
-  metadata.gz: aef40b111d7794708b3ad2fd96c6822faf1617e9ed965479a7afeccf16818f05452b36d8e2a0f8a22be9e2c717e4e961dfb146e0d52b78cfc0393bad41f8bfbb
-  data.tar.gz: 4606c1b59c0160dde277990657a6ca07efd05634e0fb81ef0230db556dfe48abb8b66ced8b7d6038d24b018b13cce96976e8825421720cb7bd89f40474a8d5c5
+  metadata.gz: 529972ff9c59f81cf30ea2f0fcc81e09a51a8a8479b3e0a79929ce806001f3004b98368ef56953489d0721fe68462e74d1ce23f84d4a2df573c5525fdea4859f
+  data.tar.gz: 78d667532eb197842526a3e9a51584c07d8fef4530fff79a4c4f2124645760d3d0e5057a4c99c242b5812d3f07e9715627aea8ef73f62e7427ea17429373c26e

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # CHANGELOG
 
+## 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

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,6 +45,18 @@ module Vimaly
 
       response = put("/tickets/#{id}", ticket.to_json(custom_field_name_map, true))
       case response.status
+      when 200..299
+        id
+      else
+        log_warn "status: #{response.status}"
+        log_warn "        #{response.inspect}"
+        false
+      end
+    end
+
+    def add_attachment(ticket_id, file_name, file_content, request_options={})
+      response = post("/tickets/#{ticket_id}/attachments?name=#{file_name}", file_content, request_options)
+      case response.status
       when 200..299
         true
       else
@@ -64,7 +77,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
@@ -139,8 +152,8 @@ 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::ConnectionError.new("Vimaly #{api_path} call failed with response #{response.status}")
@@ -148,25 +161,31 @@ module Vimaly
       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/version.rb

@@ -1,3 +1,3 @@
 module Vimaly
-  VERSION = "0.2.2"
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimaly
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Thorsten Boettger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -144,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -180,8 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Wrapper for the Vimaly API