tessera 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0f3879b8f5f8538b9aa77e1ea3c13429155e33a
+  data.tar.gz: dfc52c94f1d2c390f2292d3c695414d8db1640b7
+SHA512:
+  metadata.gz: cdfeedc4502f4323df7980ad0ab2871e5c71a87234998ba2f5c66167edfe67c13072867f98a9a658ec6d8b02159ba8d14efa5fdd5e65bc5fff70c742617ca6ce
+  data.tar.gz: 7b884d2c4a52ae50422041ac8083917f95c31b94ac4ead6b845736b3e17b16592d417d82866be7b17fab14e3b2661c01bdf464975365610edda34c41a62f7b67

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.overcommit.yml

@@ -0,0 +1,7 @@
+PreCommit:
+ RuboCop:
+   enabled: true
+   on_warn: fail
+
+ TrailingWhitespace:
+   enabled: true

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - 'tessera.gemspec'
+    - 'spec/**/*'
+  TargetRubyVersion: 2.3
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 89
+
+Documentation:
+  Enabled: false
+
+Style/VariableName:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+tessera

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andrej@antas.cz. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andrej Antas
+
+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,179 @@
+# Tessera
+
+This gem is intended as JSON API wrapper for OTRS 6.
+
+Documentation of this API with `curl` examples can be found [here](http://doc.otrs.com/doc/manual/admin/5.0/en/html/genericinterface.html#id-1.6.12.10.7.4)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tessera'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tessera
+
+## Usage
+
+First of all you have to setup your creadentials like so:
+
+```ruby
+Tessera.configure do |config|
+  config.username = 'jon'
+  config.password = 'SuperSecret'
+  config.base_url = 'https://otrs.com/otrs/nph-genericinterface.pl/Webservice/rest/'
+end
+```
+
+Now you also have to load yourself webservice yml file locate [here](https://github.com/redrick/tessera/blob/master/templates/ticket.yml)
+Please do use one enclosed with this gem from github since name of the
+webservice is hardcoded for now, will appear in TODO section for further
+adjustments...
+
+Gem provides you `Tessera::Ticket` class to use now with following methods:
+
+### FIND
+
+You can find ticket by its ID or by array of IDS like so:
+
+```ruby
+ticket = Tessera::Ticket.find(1)
+tickets = Tessera::Ticket.find([1, 2, 3])
+```
+
+### WHERE
+
+You can search through tickets like so:
+
+```ruby
+results = Tessera::Ticket.where(Title: 'Whic%')
+```
+
+for the list of all available options to search through you can see [this
+page](http://doc.otrs.com/doc/api/otrs/6.0/Perl/Kernel/GenericInterface/Operation/Ticket/TicketSearch.pm.html)
+
+Following where call you get the results object on which you can either choose
+if you want array of Tickets or you are just interested in count of them:
+
+```ruby
+results.tickets
+
+results.count
+```
+
+### CREATE
+
+You can create new ticket like so:
+
+```ruby
+params = {
+  ticket: {
+    title: 'New ticket',
+    queue: 2,
+    state: 'new',
+    priority: 3,
+    customer_user: 'andrej',
+    customer_id: 'aaaaa'
+  },
+  article: {
+    from: 'sender@gmail.com',
+    to: 'receiver@destination.com',
+    subject: 'Hello World!',
+    body: 'Hello body!',
+    article_send: 1
+  },
+  attachment: {
+    tempfile: Rack::Test::UploadedFile.new('spec/support/files/test.pdf')
+  }
+}
+
+result = Tessera::Ticket.create(params)
+```
+
+
+OR with multiple attachments:
+
+```ruby
+params = {
+  ticket: {
+    title: 'New ticket',
+    queue: 2,
+    state: 'new',
+    priority: 3,
+    customer_user: 'andrej',
+    customer_id: 'aaaaa'
+  },
+  article: {
+    from: 'sender@gmail.com',
+    subject: 'Hello World!',
+    body: 'Hello body!',
+  },
+  attachment: [
+    {
+      tempfile: Rack::Test::UploadedFile.new('spec/support/files/test.pdf')
+    },
+    {
+      tempfile: Rack::Test::UploadedFile.new('spec/support/files/test2.pdf')
+    }
+  ]
+}
+
+result = Tessera::Ticket.create(params)
+```
+
+or creating tickets with specific usage of sending article created to `To`
+recipients like so:
+
+```ruby
+params = {
+  ticket: {
+    title: 'New ticket',
+    queue: 2,
+    state: 'new',
+    priority: 3,
+    customer_user: 'andrej',
+    customer_id: 'aaaaa'
+  },
+  article: {
+    from: 'sender@gmail.com',
+    to: 'receiver@destination.com, second@email.com',
+    subject: 'Hello World!',
+    body: 'Hello body!',
+    article_send: 1
+  }
+}
+
+result = Tessera::Ticket.create(params)
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/tessera. 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.
+
+## TODO
+
+Unfinished or stuff that needs adjusting:
+* Webservice name to configuration (or default from project yml file)
+* Update existing ticket not implemented
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tessera project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tessera/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tessera'
+require 'pry'
+Pry.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/tessera.rb

@@ -0,0 +1,55 @@
+##
+#
+# requires outside this gem folder
+#
+require 'net/http'
+require 'json'
+require 'base64'
+
+##
+#
+# requires of this gem classes
+#
+require 'tessera/version'
+require 'tessera/configuration'
+
+require 'tessera/utils/errors'
+
+require 'tessera/request'
+
+require 'tessera/api/session'
+require 'tessera/api/ticket_get'
+require 'tessera/api/ticket_list'
+require 'tessera/api/ticket_search'
+require 'tessera/api/ticket_create'
+
+require 'tessera/model/base'
+require 'tessera/model/session'
+require 'tessera/model/ticket'
+
+require 'tessera/otrs/base'
+require 'tessera/otrs/ticket'
+require 'tessera/otrs/article'
+require 'tessera/otrs/attachment'
+
+require 'tessera/ticket'
+
+##
+#
+# Main module of OTRS wrapper
+#
+# See 'tessera/configuration.rb' for more explanation how to set configuration
+#
+module Tessera
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/tessera/api/session.rb

@@ -0,0 +1,27 @@
+##
+#
+#
+#
+module Tessera
+  module Api
+    class Session
+      def self.create
+        new.create
+      end
+
+      def create
+        response = Tessera::Request.new(:post, 'Session', credentials).send
+        Tessera::Model::Session.new(response)
+      end
+
+      private
+
+      def credentials
+        {
+          UserLogin: Tessera.configuration.username,
+          Password: Tessera.configuration.password
+        }
+      end
+    end
+  end
+end