glpi-sdk-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21a3fbd08d202f883324a985278c095c0288bbc9
+  data.tar.gz: 9699a69a6c7421d6d62f1cefcf72fcd4351189ed
+SHA512:
+  metadata.gz: 557aeff7aab8fba3297b46807d07b4b5913ab4f6754acabec848bc294bb194e596033b2ea10734064786ba67d17a2be80bf28e6f85ae79199ce7b2086bec93cf
+  data.tar.gz: ead5380a4798963378c4a8e6c2cef1b7b227a136a2f3ec75be16a088ca74dbdf6ba73f47538601a58a4c4594d136611dc389befbd7df06a4758b681755689bf7

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.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 filipepmenezes@gmail.com. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in glpi-sdk-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Truly Systems
+
+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,45 @@
+# GLPI SDK for Ruby
+
+[![Project Status: WIP - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/glpi/sdk`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'glpi-sdk-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install glpi-sdk-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/truly-systems/glpi-sdk-ruby. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Glpi::Sdk::Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/truly-systems/glpi-sdk-ruby/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/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'glpi/sdk'
+
+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/glpi-sdk-ruby.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'glpi/sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'glpi-sdk-ruby'
+  spec.version       = GLPI::SDK::VERSION
+  spec.authors       = ['Filipe Menezes']
+  spec.email         = ['filipepmenezes@gmail.com']
+
+  spec.summary       = 'GLPI SDK for Ruby'
+  spec.description   = 'A Ruby library for the GLPI API'
+  spec.homepage      = 'https://github.com/truly-systems/glpi-sdk-ruby'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_runtime_dependency 'httparty'
+end

data/lib/glpi/sdk.rb

@@ -0,0 +1,16 @@
+require 'httparty'
+
+require 'glpi/sdk/version'
+require 'glpi/sdk/util/hash_converter'
+require 'glpi/sdk/session'
+require 'glpi/sdk/error'
+require 'glpi/sdk/resource'
+
+require 'glpi/sdk/resources/profile'
+require 'glpi/sdk/resources/ticket'
+require 'glpi/sdk/resources/user'
+
+module GLPI
+  module SDK
+  end
+end

data/lib/glpi/sdk/error.rb

@@ -0,0 +1,66 @@
+module GLPI
+  module SDK
+    module Error
+      ERRORS = {
+        'ERROR_ITEM_NOT_FOUND'                    => 'ItemNotFoundError',
+        'ERROR_BAD_ARRAY'                         => 'BadArrayError',
+        'ERROR_METHOD_NOT_ALLOWED'                => 'MethodNotAllowedError',
+        'ERROR_RIGHT_MISSING'                     => 'RightMissingError',
+        'ERROR_SESSION_TOKEN_INVALID'             => 'SessionTokenInvalidError',
+        'ERROR_SESSION_TOKEN_MISSING'             => 'SessionTokenMissingError',
+        'ERROR_APP_TOKEN_PARAMETERS_MISSING'      => 'AppTokenParametersMissingError',
+        'ERROR_NOT_DELETED'                       => 'NotDeletedError',
+        'ERROR_NOT_ALLOWED_IP'                    => 'NotAllowedIPError',
+        'ERROR_LOGIN_PARAMETERS_MISSING'          => 'LoginParametersMissingError',
+        'ERROR_LOGIN_WITH_CREDENTIALS_DISABLED'   => 'LoginWithCredentialsDisabledError',
+        'ERROR_GLPI_LOGIN_USER_TOKEN'             => 'LoginUserTokenError',
+        'ERROR_GLPI_LOGIN'                        => 'LoginError',
+        'ERROR_ITEMTYPE_NOT_FOUND_NOR_COMMONDBTM' => 'ItemTypeNotFoundNorCommonDBTMError',
+        'ERROR_SQL'                               => 'SQLError',
+        'ERROR_RANGE_EXCEED_TOTAL'                => 'RangeExceedTotalError',
+        'ERROR_GLPI_ADD'                          => 'AddError',
+        'ERROR_GLPI_PARTIAL_ADD'                  => 'PartialAddError',
+        'ERROR_GLPI_UPDATE'                       => 'UpdateError',
+        'ERROR_GLPI_PARTIAL_UPDATE'               => 'PartialUpdateError',
+        'ERROR_GLPI_DELETE'                       => 'DeleteError',
+        'ERROR_GLPI_PARTIAL_DELETE'               => 'PartialDeleteError'
+      }.freeze
+
+      class ItemNotFoundError < StandardError; end
+      class BadArrayError < StandardError; end
+      class MethodNotAllowedError < StandardError; end
+      class RightMissingError < StandardError; end
+      class SessionTokenInvalidError < StandardError; end
+      class SessionTokenMissingError < StandardError; end
+      class AppTokenParametersMissingError < StandardError; end
+      class NotDeletedError < StandardError; end
+      class NotAllowedIPError < StandardError; end
+      class LoginParametersMissingError < StandardError; end
+      class LoginWithCredentialsDisabledError < StandardError; end
+      class LoginUserTokenError < StandardError; end
+      class LoginError < StandardError; end
+      class ItemTypeNotFoundNorCommonDBTMError < StandardError; end
+      class SQLError < StandardError; end
+      class RangeExceedTotalError < StandardError; end
+      class AddError < StandardError; end
+      class PartialAddError < StandardError; end
+      class UpdateError < StandardError; end
+      class PartialUpdateError < StandardError; end
+      class DeleteError < StandardError; end
+      class PartialDeleteError < StandardError; end
+
+      def self.dispatch(type, message)
+        raise constantize(type), message
+      end
+
+      def self.constantize(type)
+        error_class = ERRORS[type]
+        error_class = error_class ? "#{self}::#{error_class}" : 'StandardError'
+
+        Object.const_get(error_class)
+      end
+
+      private_class_method :constantize
+    end
+  end
+end

data/lib/glpi/sdk/resource.rb

@@ -0,0 +1,62 @@
+module GLPI
+  module SDK
+    class Resource
+      def initialize(attributes = {})
+        @attributes = attributes
+      end
+
+      def self.create(session, attributes = {})
+        item_type = attributes.key?(:item_type) ? attributes.delete(:item_type) : type_name
+        payload = { input: attributes }.to_json
+        response = session.request :post, "/#{item_type}", body: payload
+        find(session, response['id'], item_type)
+      end
+
+      def self.update(session, id, attributes = {})
+        item_type = attributes.key?(:item_type) ? attributes.delete(:item_type) : type_name
+        payload = { input: attributes }.to_json
+        session.request :put, "/#{item_type}/#{id}", body: payload
+        find(session, id, item_type)
+      end
+
+      def self.destroy(session, id, item_type = nil)
+        item_type ||= type_name
+        payload = { force_purge: true }.to_json
+        response = session.request :delete, "/#{item_type}/#{id}", body: payload
+        response[0][id.to_s]
+      end
+
+      def self.find(session, id, item_type = nil)
+        item_type ||= type_name
+        response = session.request :get, "/#{item_type}/#{id}"
+        new(response)
+      end
+
+      def self.all(session, **params)
+        item_type = params.key?(:item_type) ? params.delete(:item_type) : type_name
+        endpoint = "/#{item_type}"
+        endpoint += "?#{HashConverter.to_query(params)}" if params
+        response = session.request :get, endpoint
+        response.map { |item| new(item) }
+      end
+
+      class << self
+        alias where all
+      end
+
+      def self.type_name
+        name.split('::').last
+      end
+
+      private
+
+      def method_missing(name, *args, &block)
+        @attributes.key?(name.to_s) ? @attributes[name.to_s] : super
+      end
+
+      def respond_to_missing?(name, include_private = false)
+        @attributes.key?(name.to_s)
+      end
+    end
+  end
+end

data/lib/glpi/sdk/resources/profile.rb

@@ -0,0 +1,6 @@
+module GLPI
+  module SDK
+    class Profile < Resource
+    end
+  end
+end

data/lib/glpi/sdk/resources/ticket.rb

@@ -0,0 +1,6 @@
+module GLPI
+  module SDK
+    class Ticket < Resource
+    end
+  end
+end

data/lib/glpi/sdk/resources/user.rb

@@ -0,0 +1,6 @@
+module GLPI
+  module SDK
+    class User < Resource
+    end
+  end
+end

data/lib/glpi/sdk/session.rb

@@ -0,0 +1,67 @@
+module GLPI
+  module SDK
+    class Session
+      include HTTParty
+
+      attr_accessor :token, :app_token
+
+      def initialize(url, app_token, username, password)
+        @url = url
+        @app_token = app_token
+        @auth = { username: username, password: password }
+
+        init
+      end
+
+      # Request a session token to uses other api endpoints
+      def init
+        response = request :get, '/initSession', basic_auth: @auth
+        self.token = response['session_token']
+      end
+
+      # Destroy a session identified by a session token.
+      def kill
+        request :get, '/killSession'
+        self.token = nil
+      end
+
+      # Return the current active profile
+      def active_profile
+        request :get, '/getActiveProfile'
+      end
+
+      # Return active entities of current logged user
+      def active_entities
+        request :get, '/getActiveEntities'
+      end
+
+      # Return the current php $_SESSION
+      def full_session
+        request :get, '/getFullSession'
+      end
+
+      # Return the current $CFG_GLPI
+      def glpi_config
+        request :get, '/getGlpiConfig'
+      end
+
+      def request(method, endpoint, options = {})
+        options[:base_uri] = @url
+
+        options[:headers] = options.fetch(:headers, {})
+        options[:headers]['Content-Type'] = 'application/json'
+        options[:headers]['App-Token'] = @app_token
+        options[:headers]['Session-Token'] = @token if @token
+
+        response = self.class.send(method, endpoint, options)
+
+        unless response.success?
+          type, message = response.parsed_response
+          Error.dispatch(type, message)
+        end
+
+        response.parsed_response
+      end
+    end
+  end
+end

data/lib/glpi/sdk/util/hash_converter.rb

@@ -0,0 +1,30 @@
+module GLPI
+  module SDK
+    module HashConverter
+      def self.to_query(params)
+        URI.encode_www_form(encode(params))
+      end
+
+      def self.encode(value, key = nil, out_hash = {})
+        case value
+        when Hash then
+          value.each { |k, v| encode(v, append_key(key, k), out_hash) }
+          out_hash
+        when Array then
+          value.each { |v| encode(v, "#{key}[]", out_hash) }
+          out_hash
+        when nil then ''
+        else
+          out_hash[key] = value
+          out_hash
+        end
+      end
+
+      def self.append_key(root_key, key)
+        root_key.nil? ? :"#{key}" : :"#{root_key}[#{key.to_s}]"
+      end
+
+      private_class_method :append_key, :encode
+    end
+  end
+end

data/lib/glpi/sdk/version.rb

@@ -0,0 +1,5 @@
+module GLPI
+  module SDK
+    VERSION = '0.0.2'.freeze
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: glpi-sdk-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Filipe Menezes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+description: A Ruby library for the GLPI API
+email:
+- filipepmenezes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- glpi-sdk-ruby.gemspec
+- lib/glpi/sdk.rb
+- lib/glpi/sdk/error.rb
+- lib/glpi/sdk/resource.rb
+- lib/glpi/sdk/resources/profile.rb
+- lib/glpi/sdk/resources/ticket.rb
+- lib/glpi/sdk/resources/user.rb
+- lib/glpi/sdk/session.rb
+- lib/glpi/sdk/util/hash_converter.rb
+- lib/glpi/sdk/version.rb
+homepage: https://github.com/truly-systems/glpi-sdk-ruby
+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.13
+signing_key: 
+specification_version: 4
+summary: GLPI SDK for Ruby
+test_files: []