scalingo-ruby-api 1.0.0.alpha1 → 1.0.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e414ecac6ae02a9b85d286fdfea4bb6c9a8f3c4d
-  data.tar.gz: b01e544df9c7ea1b4bc39f62ee68699764305d7e
+  metadata.gz: 6e9e1714f5175b4ee396f6b2fcca6c5b0aed7dfd
+  data.tar.gz: c9b1bcd3fcc9f48c21b9bc82a96f2fdc06052af7
 SHA512:
-  metadata.gz: c14839d474e165ebe4deaba60e98c2193aa654a2018df1b9955da73292042a8c17c8f92f8f8a9a0842093a5cf02616eff38180c7eb6cd2f6518abfb02b174aea
-  data.tar.gz: 40ac42171d6091944d4d540647d132fa4bfc061e28d6932a4ea00f5512b064ffdfea75221e18732af0a4c756eee8f04f55dd223f9e65858b98142c34f5509897
+  metadata.gz: 8e367baa5b74001b704192efcecf7cbe5591de034494c672301baf2b82e8d9cf434af9132532c45e29478caea6a21cf4487ac24ea3c7e36eee3ce63612f8f401
+  data.tar.gz: 551dfa973509fc74c8a035628378fad2b18ced9815c070b904b0af0fa256cc18d41fddc1e4c6c4b104149a2fe59dbed478a6a3b8435ead0564cddb3b26756044

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc 'Default: run unit tests'
+task :default => :test
+
+desc 'Run tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+

data/lib/scalingo/configuration.rb

@@ -10,7 +10,8 @@ module Scalingo
       :token,
       :endpoint,
       :user_agent,
-      :proxy
+      :proxy,
+      :parse_json,
     ].freeze
 
     # The adapter that will be used to connect if none is set
@@ -32,6 +33,9 @@ module Scalingo
     # The user agent that will be sent to the Api endpoint if none is set
     DEFAULT_USER_AGENT = "Scalingo Ruby Gem #{Scalingo::VERSION}".freeze
 
+    # Parse json by default, only changed when getting text result (e.g. Logs)
+    DEFAULT_PARSE_JSON = true
+
     # @private
     attr_accessor *VALID_OPTIONS_KEYS
 
@@ -59,6 +63,7 @@ module Scalingo
       self.endpoint   = DEFAULT_ENDPOINT
       self.user_agent = DEFAULT_USER_AGENT
       self.proxy      = DEFAULT_PROXY
+      self.parse_json = DEFAULT_PARSE_JSON
     end
   end
 end

data/lib/scalingo/connection.rb

@@ -3,13 +3,10 @@ Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
 
 module Scalingo
   module Connection
-    protected
-    def parse_json
-      true
-    end
-
     private
     def connection
+      raise MissingToken.new if !token
+
       options = {
         :headers => {
           'Accept' => 'application/json; charset=utf-8',
@@ -26,7 +23,7 @@ module Scalingo
         connection.use Faraday::Response::ParseJson if parse_json
         connection.use FaradayMiddleware::RaiseHttpException
         connection.adapter(adapter)
-        connection.basic_auth('', token) if token
+        connection.basic_auth('', token)
       end
     end
   end

data/lib/scalingo/endpoint.rb

@@ -77,7 +77,7 @@ module Scalingo
         @resource_class ||= begin
                               Scalingo::Endpoint.const_get(self.class.name.singularize.split('::').last)
                             rescue
-                              OpenStruct
+                              Resource
                             end
       end
 

data/lib/scalingo/error.rb

@@ -2,6 +2,9 @@ module Scalingo
   # Custom error class for rescuing from all Scalingo errors
   class Error < StandardError; end
 
+  # Raised when Scalingo try a connection without any token
+  class MissingToken < Error; end
+
   # Raised when Scalingo returns the HTTP status code 400
   class BadRequest < Error; end
 

data/lib/scalingo/logs.rb

@@ -6,6 +6,7 @@ module Scalingo
 
     def initialize(app)
       super({endpoint: ''})
+      self.parse_json = false
       @app = app
     end
 
@@ -23,10 +24,6 @@ module Scalingo
       @log_token = log_token.split('=').last
     end
 
-    def parse_json
-      false
-    end
-
     def request(method, path, options)
       options.merge!(token: log_token)
       super(method, path, options)

data/lib/scalingo/version.rb

@@ -1,4 +1,4 @@
 module Scalingo
-  VERSION = '1.0.0.alpha1'
+  VERSION = '1.0.0.alpha2'
 end
 

data/test/connection_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class ConnectionTest < BaseTestCase
+  test 'missing token' do
+    Scalingo.token = nil
+    assert_raise(Scalingo::MissingToken) do
+      Scalingo.apps.all
+    end
+  end
+
+  test 'parse_json' do
+    stub(:get, 'parse_json').to_return(body: {hello: :world}.to_json)
+    result = Scalingo.get('parse_json')
+    assert_equal({"hello" => "world"}, result)
+  end
+
+  test 'parse_json false' do
+    Scalingo.parse_json = false
+    stub(:get, 'parse_json').to_return(body: {hello: :world}.to_json)
+    result = Scalingo.get('parse_json')
+    assert_equal('{"hello":"world"}', result)
+  end
+end
+

data/test/endpoint_base_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+class EndpointBaseTest < BaseTestCase
+  class ApiMock
+    attr_accessor :method_called
+
+    Scalingo::Request::REQUEST_METHODS.each do |method|
+      define_method(method) do |path, options = {}|
+        self.method_called = OpenStruct.new(http_method: method, path: path, options: options)
+      end
+    end
+  end
+  class EndpointBaseClass
+    include Scalingo::Endpoint::Base
+  end
+
+  setup do
+    @api = ApiMock.new
+    @prefix = 'hello'
+    @base = EndpointBaseClass.new(@api, @prefix)
+  end
+
+  Scalingo::Request::REQUEST_METHODS.each do |method|
+    test "#{method}" do
+      @base.send(method)
+      assert_equal method, @api.method_called.http_method
+      assert_equal "#{@prefix}/", @api.method_called.path
+      assert_equal({}, @api.method_called.options)
+
+      @base.send(method, 'test')
+      assert_equal method, @api.method_called.http_method
+      assert_equal "#{@prefix}/test", @api.method_called.path
+      assert_equal({}, @api.method_called.options)
+
+      @base.send(method, nil, {a: 1})
+      assert_equal method, @api.method_called.http_method
+      assert_equal "#{@prefix}/", @api.method_called.path
+      assert_equal({a: 1}, @api.method_called.options)
+
+      @base.send(method, 'test', {a: 1})
+      assert_equal method, @api.method_called.http_method
+      assert_equal "#{@prefix}/test", @api.method_called.path
+      assert_equal({a: 1}, @api.method_called.options)
+    end
+  end
+
+  test 'initialize without prefix' do
+    @base = EndpointBaseClass.new(@api)
+    assert_equal 'endpoint_base_classes', @base.prefix
+  end
+end
+

data/test/endpoint_collection_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+class Scalingo::Endpoint::TestEndpoint
+end
+
+class EndpointCollectionTest < BaseTestCase
+  class ApiMock
+    def get(path, options = {})
+      path = path[0..-2]
+      {
+        path => collection,
+      }
+    end
+
+    def collection
+      [
+        {
+          id: 1,
+          name: 'test1',
+        },
+        {
+          id: 2,
+          name: 'test2',
+        },
+        {
+          id: 4,
+          name: 'test4',
+        },
+        {
+          id: 5,
+          name: 'test5',
+        },
+      ]
+    end
+  end
+
+  class CollectionTests < Scalingo::Endpoint::Collection
+  end
+
+  setup do
+    @api = ApiMock.new
+    @collection = CollectionTests.new(@api)
+  end
+
+  test 'all' do
+    result = @collection.all
+    assert_equal Array, result.class
+    assert @collection.class < Enumerable
+    assert_equal @api.collection.count, @collection.count
+  end
+
+  test 'find' do
+    result = @collection.find(2)
+    assert_equal 2, result.id
+    assert_equal 'test2', result.name
+  end
+
+  test 'collection_name' do
+    assert_equal 'collection_tests', @collection.collection_name
+  end
+
+  test 'resource_class' do
+    assert_equal Scalingo::Endpoint::Resource, @collection.resource_class
+  end
+
+  class TestEndpoints < Scalingo::Endpoint::Collection
+  end
+
+  test 'resource_class if singular class exists' do
+    @collection = TestEndpoints.new(@api, @prefix)
+    assert_equal Scalingo::Endpoint::TestEndpoint, @collection.resource_class
+  end
+
+  test 'find_by' do
+    assert_equal 'id', @collection.find_by
+  end
+end
+

data/test/endpoint_resource_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class EndpointResourceTest < BaseTestCase
+  test 'initialize' do
+    resource = Scalingo::Endpoint::Resource.new('api', 'prefix', {hello: :world, world: :hello})
+    assert_equal 'api', resource.api
+    assert_equal 'prefix', resource.prefix
+
+    assert resource.respond_to?(:hello)
+    assert_equal :world, resource.hello
+
+    assert resource.respond_to?(:world)
+    assert_equal :hello, resource.world
+  end
+end
+

data/test/request_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+class RequestTest < BaseTestCase
+  setup do
+    @request = nil
+    stub(:any, /.*/).to_return do |request|
+      @request = OpenStruct.new(
+        body: request.body,
+        http_method: request.method,
+        headers: request.headers,
+        uri: request.uri,
+        query: request.uri.query ? Hash[request.uri.query.split('&').map{|q| q.split('=')}] : {},
+        path: request.uri.path[4..-1],
+      )
+      {status: 200}
+    end
+  end
+
+  [:get, :delete].each do |sym|
+    test "#{sym}" do
+      Scalingo.public_send(sym, '')
+      assert_equal sym, @request.http_method
+      assert_equal({}, @request.query)
+      assert_equal '', @request.path
+      assert_equal nil, @request.body
+
+      Scalingo.public_send(sym, 'hello')
+      assert_equal sym, @request.http_method
+      assert_equal({}, @request.query)
+      assert_equal 'hello', @request.path
+      assert_equal nil, @request.body
+
+      Scalingo.public_send(sym, 'hello', {hello: :world})
+      assert_equal sym, @request.http_method
+      assert_equal({"hello" => "world"}, @request.query)
+      assert_equal 'hello', @request.path
+      assert_equal nil, @request.body
+    end
+  end
+
+  [:post, :patch, :put].each do |sym|
+    test "#{sym}" do
+      Scalingo.public_send(sym, '')
+      assert_equal sym, @request.http_method
+      assert_equal({}, @request.query)
+      assert_equal '', @request.path
+      assert_equal '', @request.body
+
+      Scalingo.public_send(sym, 'hello')
+      assert_equal sym, @request.http_method
+      assert_equal({}, @request.query)
+      assert_equal 'hello', @request.path
+      assert_equal '', @request.body
+
+      Scalingo.public_send(sym, 'hello', {hello: :world})
+      assert_equal sym, @request.http_method
+      assert_equal({}, @request.query)
+      assert_equal 'hello', @request.path
+      assert_equal({hello: :world}, @request.body)
+    end
+  end
+end
+

data/test/scalingo_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class ScalingoTest < BaseTestCase
+  test 'configure' do
+    Scalingo.configure do |config|
+      config.token = 'CONFIGURE_TEST'
+    end
+    assert_equal 'CONFIGURE_TEST', Scalingo.token
+  end
+
+  test 'client' do
+    assert_equal Scalingo::Client, Scalingo.client.class
+  end
+
+  test 'respond_to' do
+    assert !Scalingo.methods.include?(:get)
+    assert Scalingo.respond_to?(:get)
+  end
+
+  test 'method_missing' do
+    stub(:get, '').to_return(status: 200)
+    assert_equal Scalingo.client.get(''), Scalingo.get('')
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+require 'bundler/setup'
+require 'simplecov'
+require 'pry'
+
+SimpleCov.configure do
+  add_filter '/test/'
+end
+SimpleCov.start if ENV['COVERAGE']
+
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'active_support'
+ActiveSupport.test_order = :random
+
+require File.expand_path("../../lib/scalingo", __FILE__)
+
+WebMock.disable_net_connect!
+
+class BaseTestCase < ActiveSupport::TestCase
+  setup do
+    Scalingo.reset
+    Scalingo.token = 'EXAMPLE_TOKEN'
+  end
+
+  teardown do
+    WebMock.reset!
+  end
+
+  def endpoint_uri
+    Scalingo.endpoint.split('://').join("://:#{Scalingo.token}@")
+  end
+
+  def stub(method, path)
+    case path
+    when String
+      stub_request(method, "#{endpoint_uri}#{path}")
+    when Regexp
+      stub_request(method, /#{Regexp.quote(endpoint_uri)}#{path}/)
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scalingo-ruby-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha1
+  version: 1.0.0.alpha2
 platform: ruby
 authors:
 - Geoffroy Planquart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 description: Ruby wrapper around the web API of scalingo.io
 email:
 - geoffroy@planquart.fr
@@ -99,6 +99,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Rakefile
 - lib/faraday/raise_http_exception.rb
 - lib/scalingo.rb
 - lib/scalingo/api.rb
@@ -121,6 +122,13 @@ files:
 - lib/scalingo/realtime/logs.rb
 - lib/scalingo/request.rb
 - lib/scalingo/version.rb
+- test/connection_test.rb
+- test/endpoint_base_test.rb
+- test/endpoint_collection_test.rb
+- test/endpoint_resource_test.rb
+- test/request_test.rb
+- test/scalingo_test.rb
+- test/test_helper.rb
 homepage: https://github.com/Aethelflaed/scalingo-ruby-api
 licenses:
 - MIT
@@ -145,5 +153,12 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby API for the awesome scalingo project !
-test_files: []
+test_files:
+- test/connection_test.rb
+- test/request_test.rb
+- test/endpoint_resource_test.rb
+- test/endpoint_base_test.rb
+- test/endpoint_collection_test.rb
+- test/scalingo_test.rb
+- test/test_helper.rb
 has_rdoc: