R3c 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76640c3136df3ef8fc0329487792e6c2f0044af1
-  data.tar.gz: 5d23eb121f278cbf71ce9b560456a68f3c2bd8e9
+  metadata.gz: a2b970f2a8e10e16e9d23cea17bdab245eba09c9
+  data.tar.gz: 811116a7bd0d637a058dfe755ab765e2ad460a5f
 SHA512:
-  metadata.gz: bbeeba533fcbb60af5d3db7f381db94a08220058a9357d5f5aa841fd6bd1867e3b03052cc3a8f5ba8d57620f6b318ad07c15bf0762a8de89d9494ac0ec2a0247
-  data.tar.gz: 08b1f1227e62d69d66f3022741e3ec56bb78e0bd3817d1eb051165c705b3ecf8c2b6192894b390d5c417066aaab6f9632547bfa546d20a7c636cd4d3a1e91d30
+  metadata.gz: b48329923a182ad8f508b43a729da3426ba2826c7c24d8cf823b38177f2964fedb0115ca5b6b1898c5412fa2d36e6d0ae5fdf59e40c3efafd3436e5e467e6e3c
+  data.tar.gz: 230fb21d1e73d8a444410c5f4c8624b9a563e05c6af2d46a3aa053be6a3d95c7a6f31aa2e732f1b7f6cc17dd5d5a8c16c762b7bf4931fa53035b68fe38359dbd

data/lib/r3c.rb

@@ -1,43 +1,26 @@
 require "r3c/r3c"
 require "r3c/version"
 require "rest-client"
+require "r3c/rest_helper"
 require "json"
 
 module R3c
 
-
-def self.upload(file)
-  response = RestClient.post("#{R3c::BaseEntity.site}/uploads.json?key=#{R3c::BaseEntity.headers['X-Redmine-API-Key']}", file, {:multipart => true, :content_type => 'application/octet-stream'})
-  token = JSON.parse(response)['upload']['token']
-end
-
-def self.add_watcher(issue_id, user_id)
-  #POST /issues/[id]/watchers.[format]
-  response = RestClient.post("#{R3c::BaseEntity.site}/issues/#{issue_id}/watchers.xml?key=#{R3c::BaseEntity.headers['X-Redmine-API-Key']}", {user_id: user_id})
-end
-
-def self.remove_watcher(issue_id, user_id)
- #DELETE /issues/[id]/watchers/[user_id].[format]
-  response = RestClient.delete("#{R3c::BaseEntity.site}/issues/#{issue_id}/watchers/#{user_id}.xml?key=#{R3c::BaseEntity.headers['X-Redmine-API-Key']}")
-end
-
-
-
- def self.version
+  def self.version
     VERSION
- end
+  end
 
- def self.site site
-  R3c::BaseEntity.set_site(site)
- end
+  def self.site site
+    R3c::BaseEntity.set_site(site)
+  end
 
- def self.format format
-  R3c::BaseEntity.set_format(format)
- end
+  def self.format format
+    R3c::BaseEntity.set_format(format)
+  end
  
   def self.auth auth
     R3c::BaseEntity.auth auth
- end
+  end
 
  
  private
@@ -55,10 +38,10 @@ end
 end
 
 
-#~ R3c.site('http://localhost:3000/')
-#~ R3c.format(:xml)
+R3c.site('http://localhost:3000/')
+R3c.format(:xml)
 
-#~ R3c.auth({api: {key: '8091d55257c4c90b6d56e83322622cb5f4ecee64'}})
+R3c.auth({api: {key: '8091d55257c4c90b6d56e83322622cb5f4ecee64'}})
 
 #~ file = File.read('c:\windows-version.txt')
 #~ puts file.inspect.to_s

data/lib/r3c/r3c.rb

@@ -30,7 +30,7 @@ class BaseEntity < ActiveResource::Base
     self.headers['X-Redmine-API-Key'] = api_key
   end
   
-   def self.basic_aut(params)
+   def self.basic_auth(params)
      self.user= params[:user]
      self.password= params[:password] 
    end 
@@ -41,26 +41,32 @@ class BaseEntity < ActiveResource::Base
    
 end
 
-
-# *****   NOT yet Working ***** #
+# CRUD on Version
+# Example: R3c.project.find(1).get(:versions)
 class Version<BaseEntity
 end
 
-
-class WikiPage<BaseEntity
+# CRUD on Membership
+# Example: Get memberships: R3c.project.find(1).get(:memberships)
+# Example: Create a membership: R3c.wiki_page.new
+class Membership<BaseEntity
   #self.prefix "/projects/editing_item"
   #self.element_name ""
 end
 
-class Membership<BaseEntity
+# List wiki on a project
+# R3c.project.find(1).get("wiki/index")
+
+# Get a wiki page by name
+# R3c.project.find(1).get("wiki")
+
+# Create  a WikiPage
+# R3c.wiki_page.new
+class WikiPage<BaseEntity
   #self.prefix "/projects/editing_item"
   #self.element_name ""
 end
 
-class Enumeration<BaseEntity
-end
-# **************************** #
-
 
 # CRUD on Project
 # Call R3c.project.*
@@ -71,7 +77,21 @@ end
 
 # CRUD on Issue
 # Call R3c.issue.*
-# Example: R3c.issue.find 1
+# Examples: 
+# R3c.issue.find 1
+# issues =R3c.issue.find(:all, params: {tracker_id: 1})       #filtering (with defaul limit)
+# issues =R3c.issue.find(:all, params: { limit: 5, offset:20})    #retrieving with specified limit and offset
+# issues =R3c.issue.find(:all, params: { limit: 5, offset:20, tracker_id: 1}) #filtering and retrieving with specified limit and offset
+# issues= R3c.project.find(1).get(:issues) #retrieving a project issues
+# issues = R3c.issue.find(:all, params: {"query_id" => 12})
+# issues=R3c.issue.find(1, params: {include: "watchers"}) 
+# similarly you can include
+# - children
+# - attachments
+# - relations
+# - changesets
+# - journals
+# - watchers - Since 2.3.0
 class Issue<BaseEntity
 end
 
@@ -110,6 +130,7 @@ end
 # CRUD on TimeEntry
 # Call R3c.time_entry.*
 # Example: R3c.time_entry.first
+# Example:  R3c.project.find(1).time_entries
 class TimeEntry<BaseEntity
 end
 
@@ -122,9 +143,14 @@ end
 
 # CRUD on Query
 # Call R3c.query.find(id)
-# Example: R3c.query.find 1
+# Examples: 
+# R3c.query.find 1
+# R3c.query.all
+# R3c.query.find :all
+# R3c.issue.find(:all, params: {"query_id" => 12})
  class Query<BaseEntity
-end
+ end
+ 
  
 end
 

data/lib/r3c/rest_helper.rb

@@ -0,0 +1,49 @@
+require "rest-client"
+
+
+module R3c
+
+  def self.upload(file, format="xml")
+    response = RestClient.post("#{R3c::BaseEntity.site}/uploads.#{format}?key=#{R3c::BaseEntity.headers['X-Redmine-API-Key']}", file, {:multipart => true, :content_type => 'application/octet-stream'})
+    token = JSON.parse(response)['upload']['token']
+  end
+
+
+#Note: see r3c.rb for example about how to retrieve watchers on an issue 
+#Example: 
+# R3c.add_watcher(1, 1)
+  def self.add_watcher(issue_id, user_id, format="xml")
+    #POST /issues/[id]/watchers.[format]
+    response = RestClient.post("#{R3c::BaseEntity.site}/issues/#{issue_id}/watchers.#{format}?key=#{R3c::BaseEntity.headers['X-Redmine-API-Key']}", {user_id: user_id})
+    return JSON.parse(response) if format == "json"
+    response
+  end
+  
+#Example: 
+# R3c.remove_watcher(1, 1)
+  def self.remove_watcher(issue_id, user_id, format="xml")
+   #DELETE /issues/[id]/watchers/[user_id].[format]
+    response = RestClient.delete("#{R3c::BaseEntity.site}/issues/#{issue_id}/watchers/#{user_id}.#{format}?key=#{R3c::BaseEntity.headers['X-Redmine-API-Key']}")
+    return JSON.parse(response) if format == "json"
+    response
+  end
+
+  #Example:
+  # R3c.enumerations("issue_priorities")  
+  def self.enumerations(enumeration, format="xml")
+    #GET /enumerations/<enumeration>.[format]   #enumeration= "issue_priorities" OR  "time_entry_activities"
+    response = RestClient.get("#{R3c::BaseEntity.site}/enumerations/#{enumeration}.#{format}?key=#{R3c::BaseEntity.headers['X-Redmine-API-Key']}")   
+    return JSON.parse(response) if format == "json"
+    response
+  end
+  
+  #Example:
+  # R3c.search("sometext")  
+  def self.search(q, format = "xml")
+  # GET  '/search.xml', :q => 'recipe subproject commit', :all_words => ''
+  response = RestClient.get("#{R3c::BaseEntity.site}/search.#{format}/?key=#{R3c::BaseEntity.headers['X-Redmine-API-Key']}", {all_words: '', q: q})   
+  return JSON.parse(response) if format == "json"
+  response
+  end
+
+end

data/lib/r3c/version.rb

@@ -1,5 +1,5 @@
 module R3c
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end 
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: R3c
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Paolo Freuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -82,6 +82,7 @@ files:
 - lib/Gemfile
 - lib/r3c.rb
 - lib/r3c/r3c.rb
+- lib/r3c/rest_helper.rb
 - lib/r3c/version.rb
 homepage: https://github.com/wuatanabe/R3c
 licenses: