Initial commit of the new gooddata-ruby

Author: watson

.document

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

.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

LICENSE

@@ -0,0 +1,22 @@
+(BSD License)
+
+Copyright (c) 2010 Thomas Watson Steen & GoodData Corporation. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided
+that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and
+       the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+       and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of the GoodData Corporation nor the names of its contributors may be used to endorse
+       or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.rdoc

@@ -0,0 +1,99 @@
+= GoodData Ruby wrapper and CLI
+
+A convenient Ruby wrapper around the GoodData RESTful API.
+
+This is a two-in one tool. It both contains a wrapper class called GoodData::Base
+that you can use in your own projects and a CLI for use on the prompt.
+
+The best documentation for the API can be found using these resources:
+* http://developer.gooddata.com/api
+* https://secure.gooddata.com/gdc
+
+== Usage
+
+Install gooddata-ruby gem
+
+  gem install gooddata-ruby
+
+Now you are ready to use either the Ruby wrapper class or the CLI.
+
+=== Wrapper class usage
+
+For details of how to use the Ruby wrapper class, see the GoodData::Base RDoc.
+
+=== CLI Usage
+
+After installing the gooddata-ruby gem, GoodData is available from your command line using
+the <tt>gdr</tt> command. To get a complete overview of possible options type:
+
+  gdr --help
+
+The examples and descriptions below does not cover all the options available via the CLI.
+So remember to refer back to the <tt>--help</tt> mode.
+
+Before you do anything else, a good idea is to see if your account is set up correctly and 
+that you can log in. To do this, use the test-mode:
+
+  gdr --test
+
+==== Authentication
+
+As you saw if you ran the above test command <tt>gdr</tt> will prompt you for your GoodData username
+and password. Alternatively you can also specify it using the command line options <tt>--username</tt>
+/ <tt>-u</tt> and <tt>--password</tt> / <tt>-p</tt>. Examples:
+
+  $ gdr -u user@example.com
+  Password: 
+
+  $ gdr -u user@example.com -p secret
+
+In the latter example the password is written in clear-text in the console. This is not recommended.
+Alternatively the first method can be used.
+
+If you don't wish to write your credentials each time you connect to GoodData using <tt>gdr</tt>, you can
+create a simple gdr settings file called <tt>.gdr</tt> in the root of your users home directory. To make it
+easy you can just run the settings file generator command which will create the file for you:
+
+  gdr --write-settings
+
+==== List available projects
+
+To get a list of projects available to your GoodData user account, run:
+
+  gdr -l
+
+The output from the above command will look similar to this:
+
+     521  Some project
+    3521  Some other project
+    3642  Some third project
+
+The first column contains the project-id. You need this if you wan't to either see more details about
+the project using the <tt>--show-project</tt> mode or if you wish to delete the project using the 
+<tt>--delete-project</tt> mode.
+
+==== Create a new project
+
+To create a new project under on the GoodData servers, run:
+
+  gdr -c
+
+You will then be asked about the desired project name and summary before it's created.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself we can ignore when we pull)
+* Send us a pull request. Bonus points for topic branches.
+
+== Credits
+
+This project is developed and maintained by Thomas Watson Steen [ mailto:w@tson.dk / {@wa7son}[http://twitter.com/wa7son] ]
+
+== Copyright
+
+Copyright (c) 2010 Thomas Watson Steen & GoodData Corporation. See LICENSE for details.

Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "GoodData Ruby wrapper and CLI"
+    gem.summary = %Q{A convenient Ruby wrapper around the GoodData RESTful API}
+    gem.description = %Q{This is a two-in one tool. It both contains a wrapper class called GoodData::Base that you can use in your own projects and a CLI for use on the prompt.}
+    gem.email = "w@tson.dk"
+    gem.homepage = "http://github.com/gooddata/gooddata-ruby"
+    gem.authors = ["Thomas Watson Steen"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency 'parseconfig'
+    gem.add_dependency 'json'
+    gem.add_dependency 'rest-client'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gooddata-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

VERSION

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

bin/gdr

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/../lib/good_data_cli'
+GoodDataCli.run

lib/good_data/base.rb

@@ -0,0 +1,94 @@
+require 'logger'
+Dir[File.dirname(__FILE__) + '/**/*.rb'].each { |file| require file }
+
+# Wrapper module for all GoodData classes. See the Base class for details.
+#
+# == Logging
+#
+# The only thing contained directly in this module is logger object used to log all
+# activity in the GoodData API wrapper. Before logging, the logger must
+# first be initialized using the init_logger method. After initialization,
+# an event can be logged using the logger attribute:
+#
+#   GoodData.logger.error 'Something bad happend!'
+#
+# For details about the logger options and methods, see the
+# {Logger module documentation}[http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc].
+#
+module GoodData
+  class << self
+    attr_accessor :logger
+
+    # Prepare the Logger object. Logs to STDOUT.
+    #
+    # === Parameters
+    #
+    # * +level+ - the log level (:fatal, :error, :warn (default), :info, :debug)
+    def init_logger(level = :warn)
+      @logger = Logger.new(STDOUT)
+      @logger.level = eval("Logger::#{level.to_s.upcase}")
+    end
+  end
+
+  # = GoodData API wrapper
+  #
+  # A convenient Ruby wrapper around the GoodData RESTful API.
+  #
+  # The best documentation for the API can be found using these resources:
+  # * http://developer.gooddata.com/api
+  # * https://secure.gooddata.com/gdc
+  #
+  # == Usage
+  #
+  # To communicate with the API you first need a personal GoodData account.
+  # {Sign up here}[https://secure.gooddata.com/registration.html] if you havent already.
+  #
+  # Now it is just a matter of creating a new GoodData::Base object:
+  #
+  #   gd = GoodData::Base.new :username => 'gooddata_username',
+  #                           :password => 'gooddata_password'
+  #
+  # This GoodData object can now be utalized to retrieve your GoodData profile, the available
+  # projects etc.
+  #
+  class Base
+    RELEASE_INFO_PATH = '/gdc/releaseInfo'
+
+    # Creates a new GoodData API wrapper
+    #
+    # === Parameters
+    #
+    # * +attributes+ - A Hash of configuration attributes.
+    #
+    # ==== Possible attributes:
+    #
+    # * :username (required)
+    # * :password (required)
+    # * :log_level (defaults to :warn) - see GoodData.init_logger for possible values.
+    #
+    # The Hash keys can be both symbols and strings. So :username is just as good as 'username'.
+    def initialize(attributes)
+      attributes = attributes.inject({}) { |memo, (k,v)| memo[k.to_sym] = v; memo } # convert all attribute keys to symbols
+      attributes = { :log_level => :warn }.merge attributes
+      GoodData.init_logger attributes[:log_level]
+      Connection.instance.set_credentials attributes[:username], attributes[:password]
+    end
+
+    # Returns the currently logged in user Profile.
+    def profile
+      @profile ||= Profile.load
+    end
+
+    # Returns an Array of projects.
+    #
+    # The Array is of type GoodData::Collections::Projects and each element is of type GoodData::Project.
+    def projects
+      @projects ||= profile.projects
+    end
+
+    # Returns information about the GoodData API as a Hash (e.g. version, release time etc.)
+    def release_info
+      @release_info ||= Connection.instance.get(RELEASE_INFO_PATH)['release']
+    end
+  end
+end

lib/good_data/collections/projects.rb

@@ -0,0 +1,25 @@
+module GoodData
+  module Collections
+    class Projects < Array
+      def create(attributes)
+        GoodData.logger.info "Creating project #{attributes[:name]}"
+
+        json = {
+          'meta' => {
+            'title' => attributes[:name],
+            'summary' => attributes[:summary]
+          },
+          'content' => {
+            # 'state' => 'ENABLED',
+            'guidedNavigation' => 1
+          }
+        }
+
+        json['mata']['projectTemplate'] = attributes[:template] if attributes.has_key? :template
+
+        self << Project.create(json)
+        last
+      end
+    end
+  end
+end