openproject_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68cc46b14855c5f876562d29894f8178743f53d3b4b4b69aadbefac7122e1d3a
+  data.tar.gz: f82e5b462670ba24fadc94df44d5b48d5911d4fa9126448ddf6994d9ce3fb807
+SHA512:
+  metadata.gz: e574c9fbcd7aa834ef87f1cd1a247bddbeb41d78525644a69fffb7101e2d6b7cc3d8c2c01999483a028c7a743f42dbc92081808d546adcac08eaca5f9aa19a03
+  data.tar.gz: 653926c310c30d04a4eeacdf11f58de21903182d6ff42a935c9833e4f2049da65539f2dfd329e0b82f450d0206f61683a62cf21a3e96bacf0e166e97b08f7944

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    openproject_api (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  openproject_api!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :generate_files do
+	File.write(File.expand_path('files.txt', __dir__), Dir['lib/**/*', 'Gemfile', 'Gemfile.lock', 'openproject-api.gemspec', 'Rakefile', 'files.txt'].join("\n"))
+end

data/files.txt

@@ -0,0 +1,17 @@
+lib/openproject_api
+lib/openproject_api/version.rb
+lib/openproject_api/client
+lib/openproject_api/client/time_entries.rb
+lib/openproject_api/client/work_packages.rb
+lib/openproject_api/client/statuses.rb
+lib/openproject_api/client/types.rb
+lib/openproject_api/client/projects.rb
+lib/openproject_api/objectified_hash.rb
+lib/openproject_api/api.rb
+lib/openproject_api/client.rb
+lib/openproject_api.rb
+Gemfile
+Gemfile.lock
+openproject_api.gemspec
+Rakefile
+files.txt

data/lib/openproject_api/api.rb

@@ -0,0 +1,67 @@
+require 'uri'
+require 'net/https'
+require 'json'
+require_relative 'objectified_hash'
+
+module OpenprojectApi
+	class Api
+		attr_accessor :endpoint
+		attr_accessor :apikey
+		
+		def initialize(endpoint:, apikey:)
+			self.endpoint = endpoint
+			self.apikey   = apikey
+		end
+		
+		def request(resource, query: {}, &block)
+			uri = URI.join(endpoint, resource)
+			uri.query = URI.encode_www_form(query)
+			
+			response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme=='https') do |http|
+				request = yield(uri)
+				
+				request.basic_auth('apikey', apikey)
+				
+				http.request(request)
+			end
+			
+			if response.is_a?(Net::HTTPSuccess)
+				ObjectifiedHash.new(JSON.parse(response.body))
+			else
+				response.error!
+			end
+		end
+		
+		def get(resource, *args)
+			request(resource, *args) do |uri|
+				Net::HTTP::Get.new(uri.request_uri)
+			end
+		end
+		
+		def post(resource, body, *args)
+			request(resource, *args) do |uri|
+				Net::HTTP::Post.new(uri.request_uri).tap do |request|
+					request['Content-Type'] = 'application/json'
+					request['Accept'      ] = 'application/json'
+					request.body            = body.to_json
+				end
+			end
+		end
+		
+		def patch(resource, body, *args)
+			request(resource, *args) do |uri|
+				Net::HTTP::Patch.new(uri.request_uri).tap do |request|
+					request['Content-Type'] = 'application/json'
+					request['Accept'      ] = 'application/json'
+					request.body            = body.to_json
+				end
+			end
+		end
+		
+		def delete(resource, *args)
+			request(resource, *args) do |uri|
+				Net::HTTP::Delete.new(uri.request_uri)
+			end
+		end
+	end
+end

data/lib/openproject_api/client/projects.rb

@@ -0,0 +1,33 @@
+module OpenprojectApi
+	class Client
+		module Projects
+			def projects(*args)
+				get('/api/v3/projects', *args)
+			end
+			
+			def project(project_id, *args)
+				get("/api/v3/projects/#{project_id}", *args)
+			end
+			
+			def patch_project(project_id, body, *args)
+				patch("/api/v3/projects/#{project_id}", body, *args)
+			end
+			
+			def create_project(body, *args)
+				get('/api/v3/projects', body, *args)
+			end
+			
+			def delete_project(project_id, *args)
+				delete("/api/v3/projects/#{project_id}", *args)
+			end
+			
+			def project_types(project_id, *args)
+				get("/api/v3/projects/#{project_id}/types", *args)
+			end
+			
+			def project_available_parent_project_candidates(*args)
+				get('/api/v3/projects/available_parent_projects', *args)
+			end
+		end
+	end
+end

data/lib/openproject_api/client/statuses.rb

@@ -0,0 +1,13 @@
+module OpenprojectApi
+	class Client
+		module Statuses
+			def statuses(*args)
+				get('/api/v3/statuses', *args)
+			end
+			
+			def status(status_id, *args)
+				get("/api/v3/statuses/#{status_id}", *args)
+			end
+		end
+	end
+end

data/lib/openproject_api/client/time_entries.rb

@@ -0,0 +1,29 @@
+module OpenprojectApi
+	class Client
+		module TimeEntries
+			def time_entries(*args)
+				get('/api/v3/time_entries', *args)
+			end
+			
+			def time_entry(time_entry_id, *args)
+				get("/api/v3/time_entries/#{time_entry_id}", *args)
+			end
+			
+			def patch_time_entry(time_entry_id, body, *args)
+				patch("/api/v3/time_entries/#{time_entry_id}", body, *args)
+			end
+			
+			def create_time_entry(body, *args)
+				post('/api/v3/time_entries', body, *args)
+			end
+			
+			def delete_time_entry(time_entry_id, *args)
+				delete("/api/v3/time_entries/#{time_entry_id}", *args)
+			end
+			
+			def time_entries_available_projects(*args)
+				get('/api/v3/time_entries/available_projects', *args)
+			end
+		end
+	end
+end

data/lib/openproject_api/client/types.rb

@@ -0,0 +1,13 @@
+module OpenprojectApi
+	class Client
+		module Types
+			def types(*args)
+				get('/api/v3/types', *args)
+			end
+			
+			def type(type_id, *args)
+				get("/api/v3/types/#{type_id}", *args)
+			end
+		end
+	end
+end

data/lib/openproject_api/client/work_packages.rb

@@ -0,0 +1,69 @@
+module OpenprojectApi
+	class Client
+		module WorkPackages
+			def work_packages(*args)
+				get('/api/v3/work_packages', *args)
+			end
+			
+			def work_package(work_package_id, *args)
+				get("/api/v3/work_packages/#{work_package_id}", *args)
+			end
+			
+			def patch_work_package(work_package_id, body, *args)
+				patch("/api/v3/work_packages/#{work_package_id}", body, *args)
+			end
+			
+			def create_work_package(body, *args)
+				post('/api/v3/work_packages', body, *args)
+			end
+			
+			def delete_work_package(work_package_id, *args)
+				delete("/api/v3/work_packages/#{work_package_id}", *args)
+			end
+			
+			def work_package_relations(work_package_id, *args)
+				get("/api/v3/work_packages/#{work_package_id}/relations", *args)
+			end
+			
+			def add_work_package_relation(work_package_id, body, *args)
+				post("/api/v3/work_packages/#{work_package_id}/relations", body, *args)
+			end
+			
+			def work_package_available_relation_candidates(work_package_id, *args)
+				get("/api/v3/work_packages/#{work_package_id}/available_relation_candidates", *args)
+			end
+			
+			def work_package_watchers(work_package_id, *args)
+				get("/api/v3/work_packages/#{work_package_id}/watchers", *args)
+			end
+			
+			def add_work_package_watcher(work_package_id, body, *args)
+				post("/api/v3/work_packages/#{work_package_id}/watchers", body, *args)
+			end
+			
+			def delete_work_package_watcher(work_package_id, watcher_id, *args)
+				get("/api/v3/work_packages/#{work_package_id}/watchers/#{watcher_id}", *args)
+			end
+			
+			def work_package_available_watchers(work_package_id, *args)
+				get("/api/v3/work_packages/#{work_package_id}/available_watchers", *args)
+			end
+			
+			def work_package_activities(work_package_id, *args)
+				get("/api/v3/work_packages/#{work_package_id}/activities", *args)
+			end
+			
+			def add_work_package_activity(work_package_id, body, *args)
+				post("/api/v3/work_packages/#{work_package_id}/activities", body, *args)
+			end
+			
+			def work_package_available_assignees(work_package_id, *args)
+				get("/api/v3/work_packages/#{work_package_id}/available_assignees", *args)
+			end
+			
+			def work_package_available_responsibles(work_package_id, *args)
+				get("/api/v3/work_packages/#{work_package_id}/available_responsibles", *args)
+			end
+		end
+	end
+end

data/lib/openproject_api/client.rb

@@ -0,0 +1,15 @@
+require_relative 'api'
+
+module OpenprojectApi
+	class Client < Api
+		Dir[File.expand_path('client/*.rb', __dir__)].each do |f|
+			require f
+		end
+		
+		include Projects
+		include Statuses
+		include TimeEntries
+		include Types
+		include WorkPackages
+	end
+end

data/lib/openproject_api/objectified_hash.rb

@@ -0,0 +1,44 @@
+# Slightly modified version from https://github.com/NARKOZ/gitlab/blob/3dd41722670570069693cc9b84c73f475d95e6be/lib/gitlab/objectified_hash.rb
+
+module OpenprojectApi
+  class ObjectifiedHash
+    def initialize(hash)
+      @hash = hash
+      @data = hash.each_with_object({}) do |(key, value), data|
+        value          = self.class.new(value) if value.is_a? Hash
+        value          = value.map { |v| v.is_a?(Hash) ? self.class.new(v) : v } if value.is_a? Array
+        data[key.to_s] = value
+      end
+    end
+
+    def to_hash
+      @hash
+    end
+    alias to_h to_hash
+
+    def inspect
+      "#<#{self.class}:#{object_id} {hash: #{@hash.inspect}}"
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      if @data.key?(method_name.to_s)
+        @data[method_name.to_s]
+      elsif @data.respond_to?(method_name)
+        @data.send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
+    end
+  end
+end
+

data/lib/openproject_api/version.rb

@@ -0,0 +1,3 @@
+module OpenprojectApi
+	VERSION = '0.1.1'
+end

data/lib/openproject_api.rb

@@ -0,0 +1,6 @@
+require_relative 'openproject_api/version'
+require_relative 'openproject_api/client'
+
+module OpenprojectApi
+	class Error < StandardError; end
+end

data/openproject_api.gemspec

@@ -0,0 +1,20 @@
+require_relative 'lib/openproject_api/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = 'openproject_api'
+	spec.version       = OpenprojectApi::VERSION
+	spec.authors       = ['expeehaa']
+	spec.email         = ['expeehaa@outlook.com']
+
+	spec.summary       = %q{Ruby interface for the OpenProject API.}
+	spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+	spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+	# Specify which files should be added to the gem when it is released.
+	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+	spec.files         = File.read(File.expand_path('files.txt', __dir__)).split("\n")
+	spec.bindir        = 'exe'
+	spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+	spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: openproject_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- expeehaa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-22 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- expeehaa@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- files.txt
+- lib/openproject_api.rb
+- lib/openproject_api/api.rb
+- lib/openproject_api/client.rb
+- lib/openproject_api/client/projects.rb
+- lib/openproject_api/client/statuses.rb
+- lib/openproject_api/client/time_entries.rb
+- lib/openproject_api/client/types.rb
+- lib/openproject_api/client/work_packages.rb
+- lib/openproject_api/objectified_hash.rb
+- lib/openproject_api/version.rb
+- openproject_api.gemspec
+homepage: 
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby interface for the OpenProject API.
+test_files: []