redmine-ruby 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem 'her'
+gem 'faraday_middleware'
+gem 'multi_xml'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,59 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.9)
+    builder (3.1.4)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    git (1.2.5)
+    her (0.6.7)
+      activemodel (>= 3.0.0)
+      activesupport (>= 3.0.0)
+      faraday (~> 0.8)
+      multi_json (~> 1.7)
+    i18n (0.6.4)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.8.0)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.3)
+    shoulda-matchers (2.2.0)
+      activesupport (>= 3.0.0)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  faraday_middleware
+  her
+  jeweler (~> 1.8.4)
+  multi_xml
+  rdoc (~> 3.12)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jan Schwenzien
+
+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,47 @@
+# redmine-ruby
+
+
+## Installation
+
+    gem install redmine-ruby
+
+Or in your Gemfile:
+
+    gem 'redmine-ruby'
+
+## Usage
+
+    require 'redmine-ruby'
+    
+    client = Redmine::Client.new(URL, TOKEN)
+    
+    client.projects
+    # returns the Her::Model Issue
+    # see https://github.com/remiprev/her#usage
+    
+    client.issues
+    # returns the Her::Model Issue
+    
+    client.issues.all( project_id: 'PROJECT_KEY' )
+    # returns a Her::Model::Relation
+    
+    client.issues.all( project_id: 'PROJECT_KEY' ).map do |issue|
+      # do something...
+    end
+    
+That is all for now. Please help creating the other [Redmine API methods](http://www.redmine.org/projects/redmine/wiki/Rest_api).
+
+
+## Contributing to redmine-ruby
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## License
+
+This gem is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "redmine-ruby"
+  gem.homepage = "http://github.com/GeneralScripting/redmine-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby Redmine Client using Her}
+  gem.description = %Q{Ruby Redmine Client using Her}
+  gem.email = "jan@general-scripting.com"
+  gem.authors = ["Jan Schwenzien"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "redmine-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/redmine-ruby.rb

@@ -0,0 +1,46 @@
+require 'her'
+
+require 'multi_xml'
+require 'redmine-ruby/middleware/xml_parser.rb'
+
+require 'redmine-ruby/base.rb'
+require 'redmine-ruby/project.rb'
+require 'redmine-ruby/issue.rb'
+
+module Redmine
+  class Client
+    attr_accessor :url, :token, :api
+
+    def initialize(url, token)
+      self.url    = url
+      self.token  = token
+      self.api = Her::API.new
+      self.api.setup url: url, ssl: { verify: false } do |c|
+        c.use Faraday::Request::BasicAuthentication, token, ''
+        c.use Faraday::Request::UrlEncoded
+        c.use Redmine::Middleware::XmlParser
+        c.use Faraday::Adapter::NetHttp
+      end
+    end
+
+    def resource(name, options={})
+      klass   = "Redmine::#{name.to_s.classify}".constantize
+      the_api = api
+      Class.new(klass) do |c|
+        c.uses_api        the_api
+        c.element_name    name.to_s.underscore.to_sym
+        c.collection_path klass.collection_path
+        c.resource_path   klass.resource_path
+      end
+    end
+
+    def projects
+      resource(:project)
+    end
+
+    def issues
+      resource(:issue)
+    end
+
+  end
+end

data/lib/redmine-ruby/base.rb

@@ -0,0 +1,16 @@
+module Redmine
+  class Base
+    include Her::Model
+
+    parse_root_in_json true
+
+    def self.element_name(name)
+      @_her_root_element = name
+    end
+
+    def self.parse(data)
+      data.keys.include?(root_element) ? data[root_element] : data
+    end
+
+  end
+end

data/lib/redmine-ruby/custom_field.rb

@@ -0,0 +1,6 @@
+module Redmine
+  class CustomField < Base
+    #collection_path "projects/:project_id/issues.xml"
+    #resource_path "projects/:project_id/issues/:id.xml"
+  end
+end

data/lib/redmine-ruby/issue.rb

@@ -0,0 +1,6 @@
+module Redmine
+  class Issue < Base
+    collection_path "projects/:project_id/issues.xml"
+    resource_path "projects/:project_id/issues/:id.xml"
+  end
+end

data/lib/redmine-ruby/middleware/xml_parser.rb

@@ -0,0 +1,24 @@
+module Redmine
+  module Middleware
+    class XmlParser < Faraday::Response::Middleware
+      def parse(body)
+        json = ::MultiXml.parse(body).symbolize_keys
+        json = json.values.first if json.values.first.is_a?(Array)
+        {
+          :data => json,
+          :errors => {},
+          :metadata => {}
+        }
+      end
+      
+      def on_complete(env)
+        env[:body] = case env[:status]
+        when 204
+          parse('<xml />')
+        else
+          parse(env[:body])
+        end
+      end
+    end
+  end
+end

data/lib/redmine-ruby/project.rb

@@ -0,0 +1,6 @@
+module Redmine
+  class Project < Base
+    collection_path "projects.xml"
+    resource_path "projects/:id.xml"
+  end
+end

data/redmine-ruby.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "redmine-ruby"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jan Schwenzien"]
+  s.date = "2013-07-01"
+  s.description = "Ruby Redmine Client using Her"
+  s.email = "jan@general-scripting.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/redmine-ruby.rb",
+    "lib/redmine-ruby/base.rb",
+    "lib/redmine-ruby/custom_field.rb",
+    "lib/redmine-ruby/issue.rb",
+    "lib/redmine-ruby/middleware/xml_parser.rb",
+    "lib/redmine-ruby/project.rb",
+    "redmine-ruby.gemspec",
+    "test/helper.rb",
+    "test/test_redmine-ruby.rb"
+  ]
+  s.homepage = "http://github.com/GeneralScripting/redmine-ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "Ruby Redmine Client using Her"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<her>, [">= 0"])
+      s.add_runtime_dependency(%q<faraday_middleware>, [">= 0"])
+      s.add_runtime_dependency(%q<multi_xml>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<her>, [">= 0"])
+      s.add_dependency(%q<faraday_middleware>, [">= 0"])
+      s.add_dependency(%q<multi_xml>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<her>, [">= 0"])
+    s.add_dependency(%q<faraday_middleware>, [">= 0"])
+    s.add_dependency(%q<multi_xml>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'redmine-ruby'
+
+class Test::Unit::TestCase
+end

data/test/test_redmine-ruby.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRedmineRuby < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: redmine-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan Schwenzien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Ruby Redmine Client using Her
+email: jan@general-scripting.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/redmine-ruby.rb
+- lib/redmine-ruby/base.rb
+- lib/redmine-ruby/custom_field.rb
+- lib/redmine-ruby/issue.rb
+- lib/redmine-ruby/middleware/xml_parser.rb
+- lib/redmine-ruby/project.rb
+- redmine-ruby.gemspec
+- test/helper.rb
+- test/test_redmine-ruby.rb
+homepage: http://github.com/GeneralScripting/redmine-ruby
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3161734950193346019
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby Redmine Client using Her
+test_files: []