platform-api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d806580b80147a7a47d05838f1c2179c9854967
-  data.tar.gz: f6ebb0950f44a755250a266b878cff127da2b6e4
+  metadata.gz: fbff6bff8a55c92ae1db28f25ced99f3e463f67c
+  data.tar.gz: c7d63a1522878e2961da7291f1e2e82ca3e5905c
 SHA512:
-  metadata.gz: cd4f2e00abc5982cc557df6e8967bd837e5f371827f39d8fa8cc61b61d733cef2baf2d1fafa78649668b5d7ba7211988accc0ce439262ad0f8d4d456e4f33328
-  data.tar.gz: 1265904dc69c2ebdb073c167c71d86da12804b76e01c78ba31395eef7a00de45c507a1d79c39becba0ab57509062e5e991361763b75c3c704a960d3c3afc5dfd
+  metadata.gz: 711ccc55ff40fdd4eaffb9841ef70a5ad38ef1b5dfec29ba204e7544f2bd833a2300d865fa33cec4a452a5ab94a023fc6a0f1d2df5123e87862d8fda334256f8
+  data.tar.gz: be18cf136fc794ea77b823a1f6b25e6770a9abcbd53d7c94078f27fbc8f59b74054920c4097fdfd95b824b2d624893368432ffaa9f0e15d4ea08874859ec9bd8

data/.gitignore

@@ -1,3 +1,4 @@
 .yardoc
 doc/
-pkg/
+pkg/
+spec/examples.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile.lock

@@ -1,22 +1,44 @@
 PATH
   remote: .
   specs:
-    platform-api (1.0.0)
-      heroics (~> 0.0.20)
+    platform-api (1.0.1)
+      heroics (~> 0.0.21)
       moneta (~> 0.8.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.1)
+    diff-lcs (1.3)
     erubis (2.7.0)
     excon (0.55.0)
-    heroics (0.0.20)
+    heroics (0.0.21)
       erubis (~> 2.0)
       excon
       multi_json (>= 1.9.2)
+    method_source (0.8.2)
     moneta (0.8.1)
     multi_json (1.12.1)
+    netrc (0.11.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
     yard (0.8.7.6)
 
 PLATFORMS
@@ -24,8 +46,11 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.3)
+  netrc
   platform-api!
+  pry
   rake
+  rspec
   yard
 
 BUNDLED WITH

data/README.md

@@ -312,6 +312,10 @@ Remember to commit and push the changes to Github.
 
 * This project follows [semver](http://semver.org) from version 1.0.0. Please
   be sure to keep this in mind if you're the project maintainer.
+* Be sure to run the very basic acceptance rspecs. The rspecs will attempt
+  to parse your oauth token for `api.heroku.com` from your `.netrc`. You can
+  optionally use the `OAUTH_TOKEN` and `ACCOUNT_EMAIL` environment variables.
+  They don't mutate anything but they might in the future.
 * Bump the version in `lib/platform-api/version.rb`
 * `bundle install` to update Gemfile.lock
 * `git commit -m 'vX.Y.Z' to stage the version and Gemfile.lock changes

data/Rakefile

@@ -22,3 +22,10 @@ task :publish do
   sh 'git push origin gh-pages'
   sh 'git checkout master'
 end
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task default: [:spec]
+rescue LoadError
+end

data/config/client-config.rb

@@ -4,12 +4,14 @@ require 'heroics'
 Heroics.default_configuration do |config|
   config.base_url = 'https://api.heroku.com'
   config.module_name = 'PlatformAPI'
-  config.schema_filepath = 'schema.json'
+  config.schema_filepath = File.join(File.expand_path('../..', __FILE__), 'schema.json')
 
   config.headers = { 'Accept' => 'application/vnd.heroku+json; version=3' }
   config.ruby_name_replacement_patterns = {
     /add[^a-z]+on/i => 'addon',
     /[\s-]+/ => '_',
   }
+  # This needs to be in single quotes to avoid interpolation during the client
+  # build
   config.cache_path = '#{Dir.home}/.heroics/platform-api'
 end

data/lib/platform-api.rb

@@ -1,6 +1,7 @@
 require 'heroics'
 require 'moneta'
 
+require_relative '../config/client-config'
 # Ruby HTTP client for the Heroku API.
 module PlatformAPI
 end

data/lib/platform-api/version.rb

@@ -1,3 +1,3 @@
 module PlatformAPI
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/platform-api.gemspec

@@ -22,7 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'netrc'
+  spec.add_development_dependency 'rspec'
 
-  spec.add_dependency 'heroics', '~> 0.0.20'
+  spec.add_dependency 'heroics', '~> 0.0.21'
   spec.add_dependency 'moneta', '~> 0.8.1'
 end

data/spec/acceptance/generated_client_spec.rb

@@ -0,0 +1,70 @@
+require 'netrc'
+require 'platform-api'
+
+describe 'The generated platform api client' do
+  it "can get account info" do
+    expect(client.account.info(email)).not_to be_empty
+  end
+
+  it "can get addon info for an app" do
+    expect(client.addon.list_by_app(an_app['name'])).not_to be_empty
+  end
+
+  it "can list apps" do
+    expect(client.app.list).not_to be_empty
+  end
+
+  it "can get app info" do
+    expect(client.app.info(an_app['name'])).to eq an_app
+  end
+
+  it "can get build info" do
+    expect(client.build.list(an_app['name'])).not_to be_empty
+  end
+
+  it "can get config vars" do
+    expect(client.config_var.info_for_app(an_app['name'])).not_to be_empty
+  end
+
+  it "can get domain list and info" do
+    domains = client.domain.list(an_app['name'])
+    expect(domains).not_to be_empty
+
+    expect(client.domain.info(an_app['name'], domains.first['hostname'])).not_to be_empty
+  end
+
+  it "can get dyno sizes" do
+    expect(client.dyno_size.list).not_to be_empty
+  end
+
+  it "can get add-on plan info" do
+    expect(client.plan.list('heroku-postgresql')).not_to be_empty
+  end
+
+  it "can get release info" do
+    expect(client.release.list(an_app['name'])).not_to be_empty
+  end
+
+  def an_app
+    @app ||= client.app.list.first
+  end
+
+  def email
+    @email
+  end
+
+  def client
+    @client ||=
+      begin
+        entry = Netrc.read['api.heroku.com']
+        if entry
+          oauth_token = entry.password
+          @email = entry.login
+        else
+          oauth_token = ENV['OAUTH_TOKEN']
+          @email = ENV['ACCOUNT_EMAIL']
+        end
+        PlatformAPI.connect_oauth(oauth_token)
+      end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'pry'
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.example_status_persistence_file_path = "spec/examples.txt"
+  config.warnings = true
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: platform-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - jkakar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,62 @@ dependencies:
     - - ">="
       - !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'
+- !ruby/object:Gem::Dependency
+  name: netrc
+  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: rspec
+  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: heroics
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.20
+        version: 0.0.21
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.20
+        version: 0.0.21
 - !ruby/object:Gem::Dependency
   name: moneta
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".yardopts"
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
@@ -103,6 +146,8 @@ files:
 - lib/platform-api/version.rb
 - platform-api.gemspec
 - schema.json
+- spec/acceptance/generated_client_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/heroku/platform-api
 licenses:
 - MIT