R3c 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5fe51ccd80003667c2ad3dc0abadddab02b00b3
-  data.tar.gz: 959e3978652765704fb4870e599602b52d5ff4c2
+  metadata.gz: 3683d6a35551f5d143d851387767f1b152ed4cca
+  data.tar.gz: 282f607810fa285b89cd49bd665d81507b67917b
 SHA512:
-  metadata.gz: d178c2e801af962c6c294a03626236bf400c7355d7feca2cab6f8348c402c73c70825260600bf06ee030cd5a3df5b8d38fc4a0ff239695d96a0aa30636d2efa0
-  data.tar.gz: 7ea9e1b6f36030f2e08218cbacc0606602608c0db9e6eaea5a720459311b81816a088c722bd66935c5130164b594f6b090f2e11f3c24e1dd757fadc339711c3f
+  metadata.gz: a05fab992150850c05fd02acb0bd4be732521b3565ef46d4442f0bce3ecd253417c45cbcf9bb60b7994f20db54b8fc776333dff0a7eaa946c4ffed113df1aeed
+  data.tar.gz: 5ae147f51e7955210f67b4d4908ce6408c5a215690c0759609c83b34f2a173c600a6d0536008ec72fef18d86d07f666ca96c83e8678c91175031a3507d2a1d79

data/README.md

@@ -4,6 +4,11 @@
 
 Rest Redmine Ruby Client
 
+Main Features:
+* Most of the API is covered 
+* Basic Auth and Key-based authentication are supported
+* Check code for more usage examples
+
 ## Setup
 
 ```
@@ -12,7 +17,7 @@ gem install R3c
 
 ## Usage
 
-### Set Redmine URL
+### Configure Redmine URL
 
 ```
 R3c.site('http://localhost:3000/')
@@ -24,11 +29,17 @@ R3c.site('http://localhost:3000/')
 R3c.format(:xml)
 ```
 
-###Use API KEY
+### Configure Authentication
 
+Key-based:
 ```
 R3c.auth({api: {key: '8091d55257c4c90b6d56e83322622cb5f4ecee64'}})
 ```
+Or Basic Auth (user/password):
+
+```
+R3c.auth({basic_auth: {user: 'admin', password: 'password'}})
+```
 
 ###Prepare to create an issue with an attachment
 
@@ -39,7 +50,7 @@ issue_params= {"project_id"=> 1, "subject"=> "This is the subject"}
 issue_params["uploads"]= [{"upload"=>{"token"=> token, "filename"=> "R3c.gemspec", "description"=> "a gemspec", "content_type"=> "text/plain"}}]
 ```
 
-###Create issue
+###Create the new issue
 
 ```
 issue= R3c.issue.create(issue_params )
@@ -51,7 +62,7 @@ issue= R3c.issue.create(issue_params )
 projects= R3c.project.all
 ```
 
-### Find user with id 1
+### Find user by id
 
 ```
 user= R3c.user.find 1

data/lib/r3c/rest_helper.rb

@@ -51,20 +51,44 @@ module R3c
     response
   end
   
+  #Example:
+  # R3c.relations(issue_id)  
+  def self.relations(issue_id)
+    response =  self.execute(method: :get, url: "#{R3c::BaseEntity.site}/issues/#{issue.id}/relations.#{format}")   
+    return JSON.parse(response) if format == "json"
+    response
+  end 
 
+   def self.add_relation(issue_id, issue_to_id, relation_type, delay=nil)
+    response =  self.execute(method: :post, url: "#{R3c::BaseEntity.site}/issues/#{issue.id}/relations.#{format}", headers: {params: {issue_to_id: issue_to_id, relation_type: relation_type, delay: delay}})   
+    return JSON.parse(response) if format == "json"
+    response
+   end
+   
+   def self.get_relation(relation_id)
+    response =  self.execute(method: :get, url: "#{R3c::BaseEntity.site}/relations/#{relation_id}.#{format}")   
+    return JSON.parse(response) if format == "json"
+    response
+   end
+   
+   def self.delete(relation_id)
+    response =  self.execute(method: :delete, url: "#{R3c::BaseEntity.site}/relations/#{relation_id}.#{format}")   
+    return JSON.parse(response) if format == "json"
+    response
+   end
   
   #Example:
   # R3c.search("sometext")  
-  def self.search(q, format = "xml")
+  def self.search(q, format = "json")
   # GET  '/search.xml', :q => 'recipe subproject commit', :all_words => ''
   response = execute(method: :get, url: "#{R3c::BaseEntity.site}/search.#{format}",  headers: {params: {all_words: "", q: q}} )  
-  return JSON.parse(response) if format == "json"
+  return JSON.parse(response)# if format == "json"
   response
   end
 
  private
   def self.execute(params)
-   params = add_basic_auth(params)
+   params = add_auth(params)
    params= set_ssl_params(params)
    puts "rest-helper.rb->execute: params="+params.inspect.to_s
    RestClient::Request.execute(params)

data/lib/r3c/version.rb

@@ -1,5 +1,5 @@
 module R3c
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end 
 
 

data/test/test_r3c.rb

@@ -0,0 +1,86 @@
+require 'minitest/autorun'
+require 'r3c'
+
+#Assume an new empty redmine installation running on localhost on  port 3000
+class R3cTest < Minitest::Test
+  
+  
+   #Connection  
+    R3c.site "http://localhost:3000"
+    R3c.format :xml
+    R3c.auth basic_auth:{user: "admin", password: "password"}
+
+
+  #Create, Update and Delete a Project
+  def test_crud_project
+    #create
+    @project= create_project
+    assert_equal @project.name, R3c.project.find(@project.id).name  
+    size= R3c.project.all.size
+    #update
+    @project.name="replaced"
+    @project.save!
+    assert_equal "replaced", R3c.project.find(@project.id).name  
+    #delete
+    delete_project(@project.id)
+    assert_equal (size-1), R3c.project.all.size
+  end
+
+   #Operations on issues
+   def test_issues
+    #create a project container	   
+    @project= create_project
+    #create first issue
+    @issue = R3c.issue.new
+    @issue.subject="Issue for test"
+    @issue.project_id = @project.id
+    @issue.save!
+    assert 1, R3c.issue.all.size
+    #update issue
+    @issue.subject="Subject Changed"
+    @issue.save!
+    assert_equal "Subject Changed", R3c.issue.find(@issue.id).subject
+    #attach file
+     file = File.read('c:\windows-version.txt')
+     token = R3c.upload file
+     random_string=('a'..'z').to_a.shuffle.first(8).join 
+     issue_params= {"project_id"=> 1, "subject"=> "This is the subject #{random_string}"}
+     issue_params["uploads"]= [{"upload"=>{"token"=> token, "filename"=> "R3c.gemspec", "description"=> "a gemspec", "content_type"=> "text/plain"}}]
+     @issue= R3c.issue.create(issue_params)
+     @issue= R3c.issue.find(@issue.id, params: {include: "attachments"})
+     assert_equal "R3c.gemspec", @issue.attachments.first.filename
+    #add a note
+    #TBD
+    #add wathcher
+    R3c.add_watcher(@issue.id, 1)
+    @issue= R3c.issue.find(@issue.id, params: {include: "watchers"})
+    assert_equal 1, @issue.watchers.size
+    #remove watcher
+    R3c.remove_watcher(@issue.id, 1)
+    @issue= R3c.issue.find(@issue.id, params: {include: "watchers"})
+    assert_equal 0, @issue.watchers.size
+    #search
+    results= R3c.search(random_string)
+    assert_equal 1, results["results"].size
+    #delete issue
+    R3c.issue.delete @issue.id
+    assert 0, R3c.issue.all.size
+    #clean up project
+    delete_project(@project.id)
+   end
+
+
+
+  private
+    def create_project
+      @project = R3c.project.new
+      @project.name = ('a'..'z').to_a.shuffle.first(8).join #random project name
+      @project.identifier=@project.name
+      @project.save!
+      @project
+    end
+    
+    def delete_project(id)
+          R3c.project.delete id
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: R3c
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Paolo Freuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-24 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -84,6 +84,7 @@ files:
 - lib/r3c/r3c.rb
 - lib/r3c/rest_helper.rb
 - lib/r3c/version.rb
+- test/test_r3c.rb
 homepage: https://github.com/wuatanabe/R3c
 licenses:
 - MIT