vimaly 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d14adbbb6cfb6bcd28a369de71608726014a378b
+  data.tar.gz: bcc970b7e562eed22ae9b180a1e9737aa2bf103d
+SHA512:
+  metadata.gz: 6b422a4e99ebb3dc15fc35bf4ef43c90c85582d951ee335cfd1069c35a184c0c741801e9b211125caedcc855fb3bb794343dda60dae0bf9d0780cdee727c9a51
+  data.tar.gz: d2c65390339e2c1791865126c9951d484cedfe6a4bae5c5bfb55acaaa65020a90a1b02628e9bcf0cd5c11e9bafae2b24b9fa4a7b8729e6206c35c29f4bee1b60

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset
+/_ignore
+.idea/
+
+# Ignore company specific test config
+test/integration/vimaly_config.rb

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# CHANGELOG
+
+## 0.1.0 (not yet released)
+
+ * initial copy from the `investapp`
+
+## 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/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at boettger@mt7.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vimaly.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Thorsten Böttger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Vimaly
+
+[![Gem Version](https://badge.fury.io/rb/vimaly.svg)](http://badge.fury.io/rb/vimaly)
+[![Build Status](https://travis-ci.org/sharesight/vimaly.svg?branch=master)](https://travis-ci.org/sharesight/vimaly)
+
+The `vimaly` gem provides a wrapper around the
+[Vimaly API](https://vimaly.com/public/rest-help.html)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vimaly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vimaly
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sharesight/vimaly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vimaly"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vimaly/bin.rb

@@ -0,0 +1,12 @@
+module Vimaly
+  class Bin
+
+    attr_reader :id, :name
+
+    def initialize(id, name)
+      @id = id
+      @name = name
+    end
+
+  end
+end

data/lib/vimaly/client.rb

@@ -0,0 +1,176 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'date'
+
+module Vimaly
+  class Client
+
+    VIMALY_ROOT_URL = "https://o1.vimaly.com"
+    CUSTOM_FIELD_TYPES = [::NilClass, ::String, ::Float, ::Integer, ::Array, ::Date]
+
+    def initialize(company_id, username, password, logger=nil)
+      @company_id = company_id
+      @username = username
+      @password = password
+      @logger = logger
+
+      @bin_tickets = {}
+    end
+
+    def create_ticket(title, description, format: 'text', ticket_type_name: 'bug', bin_name: /please panic/i, **others)
+      ticket = Ticket.new({
+        title: title,
+        description: description,
+        format: format,
+        ticket_type: ticket_type(ticket_type_name),
+        bin: bin(bin_name) }.
+        merge(others)
+      )
+
+      ticket_to_json = ticket.to_json(custom_field_name_map)
+      response = post("/tickets/#{next_ticket_id}", ticket_to_json)
+      case response.status
+      when 200..299
+        true
+      else
+        log_warn "status: #{response.status}"
+        log_warn "        #{response.inspect}"
+        false
+      end
+    end
+
+    def update_ticket(id, other_fields)
+      ticket = Ticket.new(other_fields)
+
+      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
+      end
+    end
+
+    def bin(name_or_regex)
+      case name_or_regex
+      when String
+        bins.detect { |bin| bin.name == name_or_regex }
+      when Regexp
+        bins.detect { |bin| bin.name =~ name_or_regex }
+      end
+    end
+
+    def bins
+      @bins ||= begin
+        get('/bins').map do |bin_data|
+          Bin.new(bin_data['_id'], bin_data['name'])
+        end
+      end
+    end
+
+    def ticket_type(name_or_regex)
+      case name_or_regex
+      when String
+        ticket_types.detect { |tt| tt.name == name_or_regex }
+      when Regexp
+        ticket_types.detect { |tt| tt.name =~ name_or_regex }
+      end
+    end
+
+    def ticket_types
+      @ticket_types ||= begin
+        get('/ticket-types').map do |bin_data|
+          TicketType.new(bin_data['_id'], bin_data['name'])
+        end
+      end
+    end
+
+    def tickets_in_named_bin(bin_name)
+      named_bin = bin(bin_name)
+      raise "Bin #{bin_name} not found" unless named_bin
+      tickets_in_bin(named_bin.id)
+    end
+
+    def tickets_in_bin(bin_id)
+      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
+      end
+    end
+
+    def matching_tickets_in_named_bin(bin_name, title_matcher)
+      named_bin = bin(bin_name)
+      raise "Bin #{bin_name} not found" unless named_bin
+      matching_tickets_in_bin(named_bin.id, title_matcher)
+    end
+
+    def matching_tickets_in_bin(bin_id, title_matcher)
+      tickets = tickets_in_bin(bin_id)
+      case title_matcher
+      when String
+        tickets.select { |t| t.title == title_matcher }
+      when Regexp
+        tickets.select { |t| t.title =~ title_matcher }
+      end
+    end
+
+    # Get custom fields as a hash of id => {id, name, type}
+    def custom_fields
+      @custom_fields ||= begin
+        Hash[get('/custom-fields').map do |cf|
+          [cf['_id'], { id: cf['_id'], name: cf['name'], type: CUSTOM_FIELD_TYPES[cf['type'].to_i] }]
+        end]
+      end
+    end
+
+    private
+
+    def custom_field_name_map
+      @custom_field_name_map ||= Hash[custom_fields.values.map {|v| [v[:name], v] }]
+    end
+
+    def next_ticket_id
+      get('/ids?amount=1')[0]
+    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' })
+      end
+      unless response.success?
+        raise("Vimaly #{api_path} call failed")
+      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' })
+      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' })
+      end
+    end
+
+    def faraday
+      @faraday ||= Faraday.new(VIMALY_ROOT_URL).tap do |connection|
+        connection.basic_auth(@username, @password)
+        connection.request(:json)
+      end
+    end
+
+    def log_warn(s)
+      @logger.warn(s) if @logger
+    end
+
+  end
+end

data/lib/vimaly/ticket.rb

@@ -0,0 +1,118 @@
+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
+      else
+        @ticket_fields = {}
+        [: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]
+        end
+      end
+    end
+
+    def self.from_vimaly(src_hash, ticket_types, bins, custom_fields)
+      ticket_fields = Hash[
+        src_hash.map do |vimaly_name, field_value|
+          case(vimaly_name)
+            when 'rtformat'
+              [:format, field_value]
+            when 'name'
+              [:title, field_value]
+            when 'ticketType_id'
+              [:ticket_type, ticket_types[field_value.to_i]]
+            when 'bin_id'
+              [:bin, bins[field_value.to_i]]
+            when 'customFields'
+              nil
+            else
+              [vimaly_name.to_sym, field_value]
+          end
+        end.compact
+      ]
+
+      (src_hash['customFields'] || []).each do |custom_field_id, value|
+        ticket_fields[custom_fields[custom_field_id][:name]] = value
+      end
+
+      Vimaly::Ticket::new(ticket_fields)
+    end
+
+    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
+            ['rtformat', field_value]
+          when :title
+            ['name', field_value]
+          when :description
+            ['description', normalise(field_value)]
+          when :ticket_type
+            ['ticketType_id', field_value.id]
+          when :bin
+            ['bin_id', field_value.id]
+          else
+            if for_update
+              fdef = custom_field_name_map[field_name.to_s]
+              ["customFields.#{fdef[:id]}", cast_to_vimaly(field_value, fdef[:type])]
+            else
+              nil
+            end
+        end
+      end.compact
+      ]
+
+      unless for_update
+        custom_fields = @ticket_fields.select {|fn, _v| ![:format, :title, :description, :ticket_type, :bin].include?(fn) }
+        if custom_fields && !custom_fields.empty?
+          vimaly_fields['customFields'] =
+            Hash[custom_fields.map do |field_name, field_value|
+              fdef = custom_field_name_map[field_name.to_s]
+              [fdef[:id], cast_to_vimaly(field_value, fdef[:type])]
+            end]
+        end
+      end
+
+      vimaly_fields
+    end
+
+    def cast_to_vimaly(value, type)
+      case type.to_s
+        when 'String'
+          value.to_s
+        when 'Float'
+          value.to_f
+        when 'Integer'
+          value.to_i
+        when 'Array'
+          value
+        when 'Date'
+          Date.parse(value.to_s).strftime('%Y-%m-%dT%H:%M:%S.%LZ')
+      end
+    end
+
+    def to_json(custom_field_name_map, for_update=false)
+      to_vimaly(custom_field_name_map, for_update).to_json
+    end
+
+    def [](name)
+      @ticket_fields[name]
+    end
+
+    def method_missing(name)
+      return @ticket_fields[name] if @ticket_fields.key?(name)
+
+      super
+    end
+
+    private
+
+    def normalise(text)
+      text.length > 40_000 ? (text[0...39_950] + '...[truncated]') : text
+    end
+
+  end
+end

data/lib/vimaly/ticket_type.rb

@@ -0,0 +1,12 @@
+module Vimaly
+  class TicketType
+
+    attr_reader :id, :name
+
+    def initialize(id, name)
+      @id = id
+      @name = name
+    end
+
+  end
+end

data/lib/vimaly/version.rb

@@ -0,0 +1,3 @@
+module Vimaly
+  VERSION = "0.2.0"
+end

data/lib/vimaly.rb

@@ -0,0 +1,9 @@
+require_relative "vimaly/version"
+require_relative "vimaly/bin"
+require_relative "vimaly/ticket_type"
+require_relative "vimaly/ticket"
+require_relative "vimaly/client"
+
+module Vimaly
+  # Your code goes here...
+end

data/vimaly.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vimaly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vimaly"
+  spec.version       = Vimaly::VERSION
+  spec.authors       = ["Thorsten Boettger"]
+  spec.email         = ["boettger@mt7.de"]
+
+  spec.summary       = %q{Wrapper for the Vimaly API}
+  spec.description   = %q{Wrapper for the Vimaly API}
+  spec.homepage      = "https://github.com/sharesight/vimaly"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "maxitest", '~> 1'
+  spec.add_development_dependency "shoulda-context"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: vimaly
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Thorsten Boettger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday_middleware
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: maxitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for the Vimaly API
+email:
+- boettger@mt7.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vimaly.rb
+- lib/vimaly/bin.rb
+- lib/vimaly/client.rb
+- lib/vimaly/ticket.rb
+- lib/vimaly/ticket_type.rb
+- lib/vimaly/version.rb
+- vimaly.gemspec
+homepage: https://github.com/sharesight/vimaly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Wrapper for the Vimaly API
+test_files: []