google-api-client 0.1.0

data/spec/google/api_client/parsers/json_parser_spec.rb

@@ -0,0 +1,51 @@
+# Copyright 2010 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+
+require 'json'
+require 'google/api_client/parsers/json_parser'
+
+describe Google::APIClient::JSONParser, 'generates json from hash' do
+  before do
+    @parser = Google::APIClient::JSONParser
+  end
+
+  it 'should translate simple hash to JSON string' do
+    @parser.serialize('test' => 23).should == '{"test":23}'
+  end
+
+  it 'should translate simple nested into to nested JSON string' do
+    @parser.serialize({
+      'test' => 23, 'test2' => {'foo' => 'baz', 12 => 3.14 }
+    }).should ==
+      '{"test2":{"12":3.14,"foo":"baz"},"test":23}'
+  end
+end
+
+describe Google::APIClient::JSONParser, 'parses json string into hash' do
+  before do
+    @parser = Google::APIClient::JSONParser
+  end
+
+  it 'should parse simple json string into hash' do
+    @parser.parse('{"test":23}').should == {'test' => 23}
+  end
+
+  it 'should parse nested json object into hash' do
+    @parser.parse('{"test":23, "test2":{"bar":"baz", "foo":3.14}}').should == {
+      'test' => 23, 'test2' => {'bar' => 'baz', 'foo' => 3.14}
+    }
+  end
+end

data/spec/google/api_client_spec.rb

@@ -0,0 +1,79 @@
+# Copyright 2010 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+
+require 'signet/oauth_1/client'
+require 'httpadapter/adapters/net_http'
+
+require 'google/api_client'
+require 'google/api_client/version'
+require 'google/api_client/parsers/json_parser'
+
+describe Google::APIClient, 'with default configuration' do
+  before do
+    @client = Google::APIClient.new
+  end
+
+  it 'should make its version number available' do
+    ::Google::APIClient::VERSION::STRING.should be_instance_of(String)
+  end
+
+  it 'should use the default JSON parser' do
+    @client.parser.should be(Google::APIClient::JSONParser)
+  end
+
+  it 'should not use an authorization mechanism' do
+    @client.authorization.should be_nil
+  end
+end
+
+describe Google::APIClient, 'with default oauth configuration' do
+  before do
+    @client = Google::APIClient.new(:authorization => :oauth_1)
+  end
+
+  it 'should make its version number available' do
+    ::Google::APIClient::VERSION::STRING.should be_instance_of(String)
+  end
+
+  it 'should use the default JSON parser' do
+    @client.parser.should be(Google::APIClient::JSONParser)
+  end
+
+  it 'should use the default OAuth1 client configuration' do
+    @client.authorization.temporary_credential_uri.to_s.should ==
+      'https://www.google.com/accounts/OAuthGetRequestToken'
+    @client.authorization.authorization_uri.to_s.should include(
+      'https://www.google.com/accounts/OAuthAuthorizeToken'
+    )
+    @client.authorization.token_credential_uri.to_s.should ==
+      'https://www.google.com/accounts/OAuthGetAccessToken'
+    @client.authorization.client_credential_key.should == 'anonymous'
+    @client.authorization.client_credential_secret.should == 'anonymous'
+  end
+end
+
+describe Google::APIClient, 'with custom pluggable parser' do
+  before do
+    class FakeJsonParser
+    end
+
+    @client = Google::APIClient.new(:parser => FakeJsonParser.new)
+  end
+
+  it 'should use the custom parser' do
+    @client.parser.should be_instance_of(FakeJsonParser)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+spec_dir = File.expand_path("..", __FILE__)
+lib_dir = File.expand_path("../lib", spec_dir)
+
+$LOAD_PATH.unshift(lib_dir)
+$LOAD_PATH.uniq!

data/tasks/clobber.rake

@@ -0,0 +1,2 @@
+desc 'Remove all build products'
+task 'clobber'

data/tasks/gem.rake

@@ -0,0 +1,76 @@
+require 'rake/gempackagetask'
+
+namespace :gem do
+  GEM_SPEC = Gem::Specification.new do |s|
+    unless s.respond_to?(:add_development_dependency)
+      puts 'The gem spec requires a newer version of RubyGems.'
+      exit(1)
+    end
+
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.summary = PKG_SUMMARY
+    s.description = PKG_DESCRIPTION
+
+    s.files = PKG_FILES.to_a
+    s.executables << 'google-api'
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = %w( README )
+    s.rdoc_options.concat ['--main',  'README']
+
+    s.add_runtime_dependency('signet', '>= 0.1.3')
+    s.add_runtime_dependency('addressable', '>= 2.2.2')
+    s.add_runtime_dependency('httpadapter', '>= 0.2.0')
+    s.add_runtime_dependency('json', '>= 1.1.9')
+    s.add_runtime_dependency('extlib', '>= 0.9.15')
+
+    s.add_development_dependency('rack', '= 1.2.0')
+    s.add_development_dependency('sinatra', '>= 1.0')
+    s.add_development_dependency('liquid', '>= 2.2.2')
+    s.add_development_dependency('rake', '>= 0.7.3')
+    s.add_development_dependency('rspec', '~> 1.2.9')
+    s.add_development_dependency('launchy', '>= 0.3.2')
+    s.add_development_dependency('diff-lcs', '>= 1.1.2')
+
+    s.require_path = 'lib'
+
+    s.homepage = PKG_HOMEPAGE
+  end
+
+  Rake::GemPackageTask.new(GEM_SPEC) do |p|
+    p.gem_spec = GEM_SPEC
+    p.need_tar = true
+    p.need_zip = true
+  end
+
+  desc 'Show information about the gem'
+  task :debug do
+    puts GEM_SPEC.to_ruby
+  end
+
+  desc 'Install the gem'
+  task :install => ['clobber', 'gem:package'] do
+    sh "#{SUDO} gem install --local pkg/#{GEM_SPEC.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PKG_NAME)
+    if installed_list &&
+        (installed_list.collect { |s| s.version.to_s}.include?(PKG_VERSION))
+      sh(
+        "#{SUDO} gem uninstall --version '#{PKG_VERSION}' " +
+        "--ignore-dependencies --executables #{PKG_NAME}"
+      )
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+end
+
+desc 'Alias to gem:package'
+task 'gem' => 'gem:package'
+
+task 'clobber' => ['gem:clobber_package']

data/tasks/git.rake

@@ -0,0 +1,40 @@
+namespace :git do
+  namespace :tag do
+    desc 'List tags from the Git repository'
+    task :list do
+      tags = `git tag -l`
+      tags.gsub!('\r', '')
+      tags = tags.split('\n').sort {|a, b| b <=> a }
+      puts tags.join('\n')
+    end
+
+    desc 'Create a new tag in the Git repository'
+    task :create do
+      changelog = File.open('CHANGELOG', 'r') { |file| file.read }
+      puts '-' * 80
+      puts changelog
+      puts '-' * 80
+      puts
+
+      v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+      abort "Versions don't match #{v} vs #{PKG_VERSION}" if v != PKG_VERSION
+
+      tag = "#{PKG_NAME}-#{PKG_VERSION}"
+      msg = "Release #{PKG_NAME}-#{PKG_VERSION}"
+
+      existing_tags = `git tag -l #{PKG_NAME}-*`.split('\n')
+      if existing_tags.include?(tag)
+        warn('Tag already exists, deleting...')
+        unless system "git tag -d #{tag}"
+          abort 'Tag deletion failed.'
+        end
+      end
+      puts "Creating git tag '#{tag}'..."
+      unless system "git tag -a -m \"#{msg}\" #{tag}"
+        abort 'Tag creation failed.'
+      end
+    end
+  end
+end
+
+task 'gem:release' => 'git:tag:create'

data/tasks/metrics.rake

@@ -0,0 +1,22 @@
+namespace :metrics do
+  task :lines do
+    lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
+    for file_name in FileList['lib/**/*.rb']
+      f = File.open(file_name)
+      while line = f.gets
+        lines += 1
+        next if line =~ /^\s*$/
+        next if line =~ /^\s*#/
+        codelines += 1
+      end
+      puts "L: #{sprintf('%4d', lines)}, " +
+        "LOC #{sprintf('%4d', codelines)} | #{file_name}"
+      total_lines     += lines
+      total_codelines += codelines
+
+      lines, codelines = 0, 0
+    end
+
+    puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
+  end
+end

data/tasks/rdoc.rake

@@ -0,0 +1,26 @@
+require 'rake/rdoctask'
+
+namespace :doc do
+  desc 'Generate RDoc documentation'
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'doc'
+    rdoc.title    = "#{PKG_NAME}-#{PKG_VERSION} Documentation"
+    rdoc.options << '--line-numbers' << '--inline-source' <<
+      '--accessor' << 'cattr_accessor=object' << '--charset' << 'utf-8'
+    rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+    rdoc.rdoc_files.include('README', 'CHANGELOG', 'LICENSE')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+
+  desc 'Generate ri locally for testing'
+  task :ri do
+    sh 'rdoc --ri -o ri .'
+  end
+
+  desc 'Remove ri products'
+  task :clobber_ri do
+    rm_r 'ri' rescue nil
+  end
+end
+
+task 'clobber' => ['doc:clobber_rdoc', 'doc:clobber_ri']

data/tasks/spec.rake

@@ -0,0 +1,78 @@
+require 'spec/rake/verify_rcov'
+
+namespace :spec do
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--require', 'rubygems', '--color', '--format', 'specdoc']
+    if RCOV_ENABLED
+      if `which rcov`.strip == ""
+        STDERR.puts "Please install rcov:"
+        STDERR.puts(
+          "sudo gem install relevance-rcov --source http://gems.github.com/"
+        )
+        exit(1)
+      end
+      t.rcov = true
+    else
+      t.rcov = false
+    end
+    t.rcov_opts = [
+      '--exclude', 'spec',
+      '--exclude', '1\\.8\\/gems',
+      '--exclude', '1\\.9\\/gems'
+    ]
+  end
+
+  Spec::Rake::SpecTask.new(:all) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--require', 'rubygems', '--color', '--format', 'specdoc']
+    t.rcov = false
+  end
+
+  Spec::Rake::SpecTask.new(:fast) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb'].exclude(
+      'spec/**/*_slow_spec.rb'
+    )
+    t.spec_opts = ['--require', 'rubygems', '--color', '--format', 'specdoc']
+    t.rcov = false
+  end
+
+  if RCOV_ENABLED
+    RCov::VerifyTask.new(:verify) do |t|
+      t.threshold = 100.0
+      t.index_html = 'coverage/index.html'
+    end
+
+    task :verify => :rcov
+  end
+
+  desc 'Generate HTML Specdocs for all specs'
+  Spec::Rake::SpecTask.new(:specdoc) do |t|
+    specdoc_path = File.expand_path(
+      File.join(File.dirname(__FILE__), '../specdoc/'))
+    Dir.mkdir(specdoc_path) if !File.exist?(specdoc_path)
+
+    output_file = File.join(specdoc_path, 'index.html')
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--format', "\"html:#{output_file}\"", '--diff']
+    t.fail_on_error = false
+  end
+
+  namespace :rcov do
+    desc 'Browse the code coverage report.'
+    task :browse => 'spec:rcov' do
+      require 'launchy'
+      Launchy::Browser.run('coverage/index.html')
+    end
+  end
+end
+
+if RCOV_ENABLED
+  desc 'Alias to spec:verify'
+  task 'spec' => 'spec:verify'
+else
+  desc 'Alias to spec:all'
+  task 'spec' => 'spec:all'
+end
+
+task 'clobber' => ['spec:clobber_rcov']

data/tasks/yard.rake

@@ -0,0 +1,26 @@
+require 'rake'
+
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+
+  namespace :doc do
+    desc 'Generate Yardoc documentation'
+    YARD::Rake::YardocTask.new do |yardoc|
+      yardoc.name = 'yard'
+      yardoc.options = ['--verbose']
+      yardoc.files = [
+        'lib/**/*.rb', 'ext/**/*.c', 'README', 'CHANGELOG', 'LICENSE'
+      ]
+    end
+  end
+
+  task 'clobber' => ['doc:clobber_yard']
+
+  desc 'Alias to doc:yard'
+  task 'doc' => 'doc:yard'
+rescue LoadError
+  # If yard isn't available, it's not the end of the world
+  desc 'Alias to doc:rdoc'
+  task 'doc' => 'doc:rdoc'
+end

metadata

@@ -0,0 +1,281 @@
+--- !ruby/object:Gem::Specification 
+name: google-api-client
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: signet
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 1
+        - 3
+        version: 0.1.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 2
+        - 2
+        version: 2.2.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: httpadapter
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 1
+        - 9
+        version: 1.1.9
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 0
+        - 9
+        - 15
+        version: 0.9.15
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: liquid
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 2
+        - 2
+        version: 2.2.2
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        - 3
+        version: 0.7.3
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: launchy
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  type: :development
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: diff-lcs
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :development
+  version_requirements: *id012
+description: |
+  The Google API Ruby Client makes it trivial to discover and access supported
+  APIs.
+
+email: 
+executables: 
+- google-api
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/google/api_client/discovery.rb
+- lib/google/api_client/parsers/json_parser.rb
+- lib/google/api_client/version.rb
+- lib/google/api_client.rb
+- spec/google/api_client/discovery_spec.rb
+- spec/google/api_client/parsers/json_parser_spec.rb
+- spec/google/api_client_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/clobber.rake
+- tasks/gem.rake
+- tasks/git.rake
+- tasks/metrics.rake
+- tasks/rdoc.rake
+- tasks/spec.rake
+- tasks/yard.rake
+- CHANGELOG
+- LICENSE
+- Rakefile
+- README
+- bin/google-api
+has_rdoc: true
+homepage: http://code.google.com/p/google-api-ruby-client/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Package Summary
+test_files: []
+