right_api_client 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01ce5cf02bf62fd9aab1e367843abd835924dbe9
-  data.tar.gz: 8ceac40391c3e53b3bcd59f43aeb63173f690b07
+  metadata.gz: 28ccc87f7f444e4e7a6d0a72695b5dc28ea9b313
+  data.tar.gz: 03f48d1c21be4aa93b53311c8562e65302820782
 SHA512:
-  metadata.gz: 0911c6c1ad7333c1e9648b9b8c0fa9c0b11d4bccf6be04662d9217aba0d581fe9a0cc542b5344e625091cdb64c04857cc52c189639ad07e4fdfdfc1d022a338a
-  data.tar.gz: 43b1c6d1cf941090a0333eace45d0b2b5bff26431c850820fe7270eedebe83bc13b1971505122d40c310674eacff224f850faf81b6e1d0e0c02a2bc0f28ec45b
+  metadata.gz: bd0bfe56b67ec25ce8ac83b8f455f329b14a7204a3140d45c5cfd1dcdd0a381777e5b760b1334941e305c5e8d2f8e295cc1f35713ac4c61ba458fd6e60bea815
+  data.tar.gz: 76ec1794e9eadd8ceb99c3430748402e30f045752b8614a9b225151ad39d7fc0ffe8e00102b9c34e156251f31046f3e353bb8fa7dbd95643255b44a8a8bc8a00

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format=nested
+--backtrace

data/CHANGELOG.md

@@ -3,7 +3,16 @@
 ## Next
  - Your info here
 
-## 1.6
+## 1.6.2
+ - \#108 Raise a specific error if the API returns an empty 200 response
+ - \#106 Bump mime-types version to resolve dependencies with fog-azure-rm gem
+ - \#104 Switch to a more bundlerish dev workflow
+ - \#102 Rework README to reflect gem version not tied to api version
+
+## 1.6.1
+ - Disassociate API version number from gem version number
+
+## 1.6.0
  - \#101 Deprecate support for ruby 1.x
  - \#100 Add support for using local proxy with RightLink10
 

data/Gemfile

@@ -2,21 +2,20 @@ source 'https://rubygems.org'
 
 # Runtime dependencies that should appear in the gemspec.
 gem 'json', '~> 1.0'
-gem 'mime-types', '~> 1.0'
+gem 'mime-types', '~> 2.0'
 gem 'rest-client', '~> 1.6'
 
 # Development dependencies that should appear in the gemspec.
 group :development do
-  gem 'rake', '0.8.7'
-  gem 'rspec', '2.9.0'
-  gem 'flexmock', '0.8.7'
+  gem 'rake'
+  gem 'rspec', '~> 2.9'
+  gem 'flexmock'
   gem 'coveralls', :require => false
   gem 'pry'
 end
 
 # Gems used during test and development that should be OMITTED from the gemspec
 group :test do
-  gem 'byebug',
-      :platforms => [:ruby_20, :ruby_21]
-  gem 'jeweler', '~> 2.0'
+  gem 'pry-byebug'
+  gem 'jeweler'
 end

data/README.md

@@ -18,10 +18,14 @@ Ruby 2.0 or higher is required as of version 1.6
     gem install right_api_client
 
 ## Versioning
-The right\_api\_client gem is versioned using the usual X.Y.Z notation, where X.Y is the
-RightScale API version, and Z is the client version. For example, if you want to use
-RightScale API 1.5, you should use the latest version of the 1.6 gem. This will ensure
-that you get the latest bug fixes for the client that is compatible with that API version.
+* Version 1.6.x
+  - API 1.5
+  - Ruby 2.0 and above
+  - Patch level receives improvements and bug fixes moving forward.
+* Version 1.5.x
+  - API 1.5
+  - Ruby 1.8, 1.9.3
+  - Patch level receives only security or high priority fixes if requested.
 
 ## Usage Instructions
 New users can start with the following few lines of code and navigate their way around the API by following

data/VERSION

@@ -1 +1 @@
-1.6.1
+1.6.2

data/bin/console

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+GIT_ROOT    = File.expand_path('../..', __FILE__)
+CONFIG_FILE = "#{GIT_ROOT}/config/login.yml"
+
+require 'yaml'
+
+require 'bundler/setup'
+
+# TODO convert from jeweler to bundler workflow and use `gemspec` directive in Gemfile
+$: << "#{GIT_ROOT}/lib"
+require 'right_api_client'
+
+begin
+  puts "Using configuration file #{CONFIG_FILE}"
+  if File.readable? CONFIG_FILE
+    @client = RightApi::Client.new(YAML.load_file(CONFIG_FILE))
+    STDERR.puts "Logged in to Rightscale CM API."
+  else
+    STDERR.puts "Configuration file is unreadable or nonexistent!"
+    STDERR.puts "Please copy login.yml.example and add your RightScale API credentials."
+    exit 1
+  end
+end
+
+puts
+puts "Opening pry or irb session; call API methods on self"
+puts "Example: self.deployments.index"
+puts
+
+begin
+  require 'pry'
+  Pry.start(@client)
+rescue LoadError
+  require 'irb'
+  IRB.setup nil
+  IRB.conf[:MAIN_CONTEXT] = IRB::Irb.new.context
+  require 'irb/ext/multi-irb'
+  IRB.irb nil, @client
+end

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/config/login.yml.example

@@ -0,0 +1,43 @@
+# The API login details can be put in a YAML file. This is an example login.yml which
+# will be needed for bin/console
+
+# Account ID is a required parameter. You can find your account number by logging into the
+# RightScale dashboard (https://my.rightscale.com), navigate to the Settings > Account Settings page.
+# The account number is at the end of the browser address bar.
+:account_id: my_account_id
+
+# There are six login mechanisms:
+
+# 0. Use the following parameters to login with your email and base64-encoded password:
+# To encode your plaintext password, use 'base64' command or similar.
+:email: my@email.com
+:password_base64: my_password_encoded_as_base64
+
+# 1. Use the following parameters to login with your email and plaintext password:
+:email: my@email.com
+:password: my_password
+
+# 2. Use the following parameter to login with an instance_token:
+# To find the instance_token, launch a server, navigate to the info page and under
+# User Data box, you will see RS_API_TOKEN = your_account_id:the_instance_token
+:instance_token: my_instance_token
+
+# 3. Use the following parameter to send a pre-authenticated cookie with every request:
+:cookies: my_cookie_string
+
+# 4. Use the following parameter to send an existing OAuth access token with every request:
+# To learn more about OAuth and how to obtain an access token, see
+# http://support.rightscale.com/12-Guides/03-Rightscale_API/OAuth
+:access_token: my_token_string
+
+# 5. Use the following parameter to use your personal OAuth Token with your requests:
+# Please be careful! This is a user-specific OAuth 2.0 refresh token representing a grant with unrestricted scope.
+# Anyone who possesses it can login to RightScale's API and perform requests on this account with all of your permissions.
+# For more information, consult http://support.rightscale.com/12-Guides/03-Rightscale_API/OAuth
+# ex: @client = RightApi::Client.new(:api_url => "https://us-x.rightscale.com", :account_id => <account_id>, :refresh_token => <token>)
+:refresh_token: my_token_string
+
+# The following are optional parameters:
+:api_url: (this defaults to https://my.rightscale.com)
+:api_version: (this defaults to 1.5)
+:ssl_version: (this defaults to TLSv1)

data/lib/right_api_client/client.rb

@@ -198,9 +198,12 @@ module RightApi
     end
 
     def to_s
-      "#<RightApi::Client #{api_url}>"
+      api_host = URI.parse(api_url).host.split('.').first rescue 'unknown'
+      "#<RightApi::Client host=#{api_host} account=#{@account_id}>"
     end
 
+    alias inspect to_s
+
     # Log HTTP calls to file (file can be STDOUT as well)
     def log(file)
       RestClient.log = file
@@ -379,6 +382,11 @@ module RightApi
                 response.body.force_encoding(charset)
               end
 
+              # raise an error if the API is misbehaving and returning an empty response when it shouldn't
+              if type != 'text' && response.body.empty?
+                raise EmptyBodyError.new(request, response)
+              end
+
               [type, response.body]
             when 301, 302
               update_api_url(response)
@@ -434,6 +442,8 @@ module RightApi
               # This is needed for the tags Resource -- which returns a 200 and has a content type
               # therefore, ResourceDetail objects needs to be returned
               if response.code == 200 && response.headers[:content_type].index('rightscale')
+                # raise an error if the API is misbehaving and returning an empty response when it shouldn't
+                raise EmptyBodyError.new(request, response) if response.body.empty?
                 resource_type = get_resource_type(response.headers[:content_type])
                 data = JSON.parse(response, :allow_nan => true)
                 # Resource_tag is returned after querying tags.by_resource or tags.by_tags.
@@ -476,8 +486,7 @@ module RightApi
             update_last_request(request, response)
 
             case response.code
-            when 200
-            when 204
+            when 200, 204
               nil
             when 301, 302
               update_api_url(response)

data/lib/right_api_client/errors.rb

@@ -39,11 +39,15 @@ module RightApi
   end
 
   class UnknownRouteError < ApiError
-
     def prefix
-
       'Unknown action or route. '
     end
   end
+
+  class EmptyBodyError < ApiError
+    def prefix
+      'Empty response body: '
+    end
+  end
 end
 

data/login_to_client_irb.rb

@@ -1,6 +1,6 @@
 # A quick way to login to the API and jump into IRB so you can experiment with the client.
 # Add this to your bash profile to make it simpler:
-#   alias client='bundle exec ruby login_to_client_irb.rb'
+#   alias client='bin/console'
 
 require File.expand_path('../lib/right_api_client', __FILE__)
 require 'yaml'

data/right_api_client.gemspec

@@ -0,0 +1,95 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: right_api_client 1.6.2 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "right_api_client"
+  s.version = "1.6.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["RightScale, Inc."]
+  s.date = "2016-11-02"
+  s.description = "\nThe right_api_client gem simplifies the use of RightScale's MultiCloud API.\nIt provides a simple object model of the API resources, and handles all of the\nfine details involved in making HTTP calls and translating their responses.\n"
+  s.email = "rubygems@rightscale.com"
+  s.executables = ["console", "setup"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".coveralls.yml",
+    ".rspec",
+    ".travis.yml",
+    "CHANGELOG.md",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/console",
+    "bin/setup",
+    "config/login.yml.example",
+    "lib/right_api_client.rb",
+    "lib/right_api_client/client.rb",
+    "lib/right_api_client/errors.rb",
+    "lib/right_api_client/exceptions.rb",
+    "lib/right_api_client/helper.rb",
+    "lib/right_api_client/resource.rb",
+    "lib/right_api_client/resource_detail.rb",
+    "lib/right_api_client/resources.rb",
+    "lib/right_api_client/version.rb",
+    "login_to_client_irb.rb",
+    "right_api_client.gemspec",
+    "right_api_client.rconf",
+    "spec/functional/client_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/mock_spec_helper.rb",
+    "spec/unit/client_spec.rb",
+    "spec/unit/helper_spec.rb",
+    "spec/unit/instance_facing_spec.rb",
+    "spec/unit/resource_detail_spec.rb",
+    "spec/unit/resource_spec.rb",
+    "spec/unit/resources_spec.rb"
+  ]
+  s.homepage = "https://github.com/rightscale/right_api_client"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.8"
+  s.summary = "RightScale MultiCloud API HTTP Client"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<mime-types>, ["~> 2.0"])
+      s.add_runtime_dependency(%q<rest-client>, ["~> 1.6"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.9"])
+      s.add_development_dependency(%q<flexmock>, [">= 0"])
+      s.add_development_dependency(%q<coveralls>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, ["~> 1.0"])
+      s.add_dependency(%q<mime-types>, ["~> 2.0"])
+      s.add_dependency(%q<rest-client>, ["~> 1.6"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.9"])
+      s.add_dependency(%q<flexmock>, [">= 0"])
+      s.add_dependency(%q<coveralls>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, ["~> 1.0"])
+    s.add_dependency(%q<mime-types>, ["~> 2.0"])
+    s.add_dependency(%q<rest-client>, ["~> 1.6"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.9"])
+    s.add_dependency(%q<flexmock>, [">= 0"])
+    s.add_dependency(%q<coveralls>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

data/spec/functional/client_spec.rb

@@ -0,0 +1,181 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe RightApi::Client, :functional=>true do
+  context "given valid OAuth credentials" do
+    before(:each) do
+      @rest_client = flexmock("rest_client")
+      flexmock(RestClient::Resource.extend(PostOverride)).should_receive(:new).and_return(@rest_client)
+
+      oauth_endpoint = flexmock("OAuth endpoint")
+      overwrite_post = flexmock("Overwrite Post")
+      oauth_post_response = '{"refresh_token": "moo", "expires_in": 3600}'
+      @rest_client.should_receive(:[]).with('/api/oauth2').and_return(oauth_endpoint)
+      oauth_endpoint.should_receive(:extend).and_return(overwrite_post)
+      overwrite_post.should_receive(:post).and_return(oauth_post_response)
+
+      get_response = "session", "{\"links\":[{\"rel\":\"deployments\",\"href\":\"/api/deployments\"}, {\"rel\":\"tags\",\"href\":\"/api/tags\"}],\"message\":\"You have successfully logged into the RightScale API.\"}"
+      session_resource = flexmock("session resource")
+      @rest_client.should_receive(:[]).with('/api/session').and_return(session_resource)
+      session_resource.should_receive(:get).and_return(get_response)
+    end
+
+    it "accepts a refresh_token when creating a new client" do
+      client = RightApi::Client.new({:refresh_token => "refresh token only"})
+      client.refresh_token.should == "refresh token only"
+    end
+  end
+
+  context "given a logged-in client" do
+    before(:each) do
+      @rest_client = flexmock("rest_client")
+      flexmock(RestClient::Resource.extend(PostOverride)).should_receive(:new).and_return(@rest_client)
+
+      cookies = {"cookies" => "cookies"}
+      get_response = "session", "{\"links\":[{\"rel\":\"deployments\",\"href\":\"/api/deployments\"}, {\"rel\":\"tags\",\"href\":\"/api/tags\"}],\"message\":\"You have successfully logged into the RightScale API.\"}"
+      post_response = flexmock("post_response", :code => 204, :cookies => cookies, :body => " ")
+      session = flexmock("session")
+      overwrite_post = flexmock("Overwrite Post")
+
+      @rest_client.should_receive(:[]).with('/api/session').and_return(session)
+      session.should_receive(:get).and_return(get_response)
+      session.should_receive(:extend).and_return(overwrite_post)
+      overwrite_post.should_receive(:post).and_return(post_response)
+
+      @client = RightApi::Client.new(:email => "email", :password => "password", :account_id => 60073)
+    end
+
+    it "logs in" do
+      @client.send(:headers)[:cookies].should == {"cookies" => "cookies"}
+      @client.cookies.class.should == Hash
+      @client.cookies["cookies"].should == "cookies"
+      @client.cookies.timestamp.should_not == nil
+      @client.session.index.message.should == 'You have successfully logged into the RightScale API.'
+    end
+
+    it "logs in with cookies" do
+      client = RightApi::Client.new({:cookies => "cookies only"})
+      client.cookies.should == "cookies only"
+    end
+
+    context 'given :access_token parameter' do
+      let(:client) { RightApi::Client.new({:access_token => "access token only"}) }
+
+      it "accepts the token" do
+        client.access_token.should == "access token only"
+
+        @rest_client.should_receive(:[]).with('/api/oauth2').never
+        deployment_session = flexmock("Deployment Session")
+        deployment_session.should_receive(:post).and_return(1)
+        @rest_client.should_receive(:[]).with('/api/deployments').and_return(deployment_session)
+
+        response = @client.deployments.create(:deployment => {:name => "deployment_name"})
+        response.should == 1
+      end
+
+      it "doesn't try to login" do
+        client.access_token.should == "access token only"
+
+        @rest_client.should_receive(:[]).with('/api/oauth2').never
+        @rest_client.should_receive(:[]).with('/api/session').never
+
+        deployment_session = flexmock("Deployment Session")
+        deployment_session.should_receive(:post).and_return(1)
+        @rest_client.should_receive(:[]).with('/api/deployments').and_return(deployment_session)
+
+        response = @client.deployments.create(:deployment => {:name => "deployment_name"})
+        response.should == 1
+      end
+    end
+
+    it "posts" do
+      deployment_session = flexmock("Deployment Session")
+      deployment_session.should_receive(:post).and_return(1)
+      @rest_client.should_receive(:[]).with('/api/deployments').and_return(deployment_session)
+      response = @client.deployments.create(:deployment => {:name => "deployment_name"})
+      response.should == 1
+    end
+
+    it "gets" do
+      deployment_session = flexmock("Deployment Session")
+      deployment_session.should_receive(:get).and_return(nil)
+      @rest_client.should_receive(:[]).with("/api/deployments/1/to_ary").and_return(deployment_session)
+      deployment = @client.deployments(:id => 1)
+      deployment.href.should == "/api/deployments/1"
+    end
+
+    it "puts" do
+      deployment_session = flexmock("Deployment Session")
+      deployment_session.should_receive(:get)
+      @rest_client.should_receive(:[]).with("/api/deployments/1/to_ary").and_return(deployment_session)
+      deployment = @client.deployments(:id => 1)
+
+      @rest_client.should_receive(:[]).with("/api/deployments/1").and_return(deployment_session)
+      deployment_session.should_receive(:put).and_return(1)
+      deployment.update(:deployment => {:name => "updated"}).should == 1
+    end
+
+    it "deletes" do
+      deployment_session = flexmock("Deployment Session")
+      deployment_session.should_receive(:get)
+      @rest_client.should_receive(:[]).with("/api/deployments/1/to_ary").and_return(deployment_session)
+      deployment = @client.deployments(:id => 1)
+
+      @rest_client.should_receive(:[]).with("/api/deployments/1").and_return(deployment_session)
+      deployment_session.should_receive(:delete).and_return(1)
+      deployment.destroy.should == 1
+    end
+
+    it "multi-adds tags as a special request" do
+      tag_session = flexmock("Tag Session")
+      tag_session.should_receive(:post).and_return(1)
+      @rest_client.should_receive(:[]).with("/api/tags/multi_add").and_return(tag_session)
+      response = @client.tags.multi_add("resource_hrefs[]=/api/deployments/1&tags[]=tag1")
+      response.should == 1
+    end
+
+    it "singularizes resource_types correctly" do
+      @client.get_singular('servers').should == 'server'
+      @client.get_singular('deployments').should == 'deployment'
+      @client.get_singular('audit_entries').should == 'audit_entry'
+      @client.get_singular('processes').should == 'process'
+      @client.get_singular('ip_addresses').should == 'ip_address'
+    end
+
+    it "returns the resource when calling #resource(href)" do
+      resource_session = flexmock("Resource Session")
+      response = "deployment","{\"links\":[{\"rel\":\"self\",\"href\":\"/api/deployments/1\"}],\"name\":\"Mock Deployment\"}"
+      resource_session.should_receive(:get).and_return(response)
+      @rest_client.should_receive(:[]).with("/api/deployments/1").and_return(resource_session)
+      deployment = @client.resource("/api/deployments/1")
+      deployment.href.should == "/api/deployments/1"
+      deployment.name.should == "Mock Deployment"
+    end
+
+    it "raises meaningful errors" do
+      error_message = flexmock("Error Message", :code => 422, :body => "ERROR")
+      @rest_client.should_receive(:[]).with("/api/nada").and_raise(RightApi::UnknownRouteError.new(error_message))
+      err = begin
+        @client.resource('/api/nada')
+      rescue => e
+        e
+      end
+
+      err.class.should == RightApi::UnknownRouteError
+      err.message.should == "Unknown action or route. HTTP Code: 422, Response body: ERROR"
+    end
+
+    it "wraps errors with _details" do
+      response = flexmock("response", :code => 422, :body => "ResourceNotFound: Couldn't find Deployment with ID=asdf ")
+      @rest_client.should_receive(:[]).with("/api/deployments/nada").and_raise(RightApi::ApiError.new(response))
+      err = begin
+        @client.deployments(:id => 'nada').show
+      rescue => e
+        e
+      end
+
+      err._details.method.should == :get
+      err._details.path.should == '/api/deployments/nada'
+      err._details.params.should == {}
+    end
+  end
+end