redminerb 0.1.0

data/lib/redminerb/client.rb

@@ -0,0 +1,44 @@
+# Copyright (c) The Cocktail Experience S.L. (2015)
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module Redminerb
+  # HTTP client to communicate w/ the Redmine server.
+  class Client
+    attr_reader :connection
+
+    def initialize(cfg)
+      @connection = Faraday.new(url: cfg.url) do |f|
+        f.adapter Faraday.default_adapter
+      end
+      @connection.basic_auth(cfg.api_key, cfg.api_key)
+    end
+
+    # Get the users of our Redmine as OpenStruct objects.
+    #
+    # Example:
+    #   Redminerb.init!
+    #   Redminerb.client.users.each do |user|
+    #      puts user.firstname
+    #   end
+    #
+    # See lib/reminerb/cli/user.rb code to see other example/s.
+
+    def users
+      get_json('/users.json')['users'].map do |user|
+        OpenStruct.new user
+      end
+    end
+
+    private
+
+    # Requests the path that receives as param and parses the body of the
+    # response received as JSON.
+    def get_json(path)
+      Redminerb.init_required!
+      JSON.parse(@connection.get(path).body)
+    end
+
+  end
+end

data/lib/redminerb/config.rb

@@ -0,0 +1,24 @@
+# Copyright 2015 The Cocktail Experience, S.L.
+require 'yaml'
+
+module Redminerb
+  # Read user's config from ~/.redminerb.yml
+  class Config
+    def initialize
+      YAML.load_file(File.join(ENV['HOME'], '.redminerb.yml')).tap do |yaml|
+        @url = yaml['url']
+        @api_key = yaml['api_key']
+      end
+    end
+
+    def url
+      Redminerb.init_required!
+      @url
+    end
+
+    def api_key
+      Redminerb.init_required!
+      @api_key
+    end
+  end
+end

data/lib/redminerb/version.rb

@@ -0,0 +1,4 @@
+# Copyright (c) The Cocktail Experience S.L. (2015)
+module Redminerb
+  VERSION = '0.1.0'
+end

data/lib/redminerb.rb

@@ -0,0 +1,49 @@
+# Copyright (c) The Cocktail Experience S.L. (2015)
+require_relative 'redminerb/version'
+require_relative 'redminerb/config'
+require_relative 'redminerb/client'
+require_relative 'redminerb/cli'
+
+# Main module 
+module Redminerb
+  class UninitializedError < StandardError; end
+
+  module_function
+
+  @initialized = false
+
+  # Module initialization needed before doing anything. It looks ~/.redminerb.yml
+  # to get the authentication info to connect with the Redmine REST API.
+  #
+  # Example:
+  #   >> Reminerb.init!
+  #   => true
+  def init!
+    @initialized = true
+    @config = Redminerb::Config.new
+    @client = Redminerb::Client.new(@config)
+  end
+
+  # NOTICE: method needed by the build. Clean the module for the next test.
+  def end!
+    @initialized = false
+    @config = nil
+    @client = nil
+  end
+
+  def initialized?
+    @initialized
+  end
+
+  def init_required!
+    fail(UninitializedError, 'Call Redminerb.init! first') unless @initialized
+  end
+
+  def config
+    @config
+  end
+
+  def client
+    @client
+  end
+end

data/redminerb.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redminerb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redminerb'
+  spec.version       = Redminerb::VERSION
+  spec.authors       = ['Fernando Garcia Samblas']
+  spec.email         = ['fernando.garcia@the-cocktail.com']
+  spec.homepage      = 'http://github.com/nando/redminerb'
+
+  spec.summary       = 'Redminerb is a command-line Redmine client.'
+  spec.description   = <<-DESC
+    Redminerb is a command-line tool to speak with a Redmine server using its REST API.
+  DESC
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'TODO: Set to http://gems.the-cocktail.com :)'
+  else
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.bindir        = 'exe'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'thor'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'faraday'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: redminerb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fernando Garcia Samblas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: rubocop
+  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: 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'
+description: |2
+      Redminerb is a command-line tool to speak with a Redmine server using its REST API.
+email:
+- fernando.garcia@the-cocktail.com
+executables:
+- redminerb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.rdoc
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENCE.txt
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/redminerb
+- lib/redminerb.rb
+- lib/redminerb/cli.rb
+- lib/redminerb/cli/users.rb
+- lib/redminerb/client.rb
+- lib/redminerb/config.rb
+- lib/redminerb/version.rb
+- redminerb.gemspec
+homepage: http://github.com/nando/redminerb
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Redminerb is a command-line Redmine client.
+test_files: []
+has_rdoc: