scalingo-provider_api 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4e698a5d131e76663c70ab7420a89ce3daaac0c
+  data.tar.gz: ec810ccff9875d804f0b22a847851593cfa8cb7e
+SHA512:
+  metadata.gz: 622504f3d66a042ad4d68a7a7185421db13fd0f584bb84882811664169aca664031a2b7b20cadc56a5864aeb8e048c346daf8662ba571fe0cf49541e2354ad1c
+  data.tar.gz: 8ca6b93a36826aec364d93624c8a6c0ef2f39943bbb086d94e324f07c66b6ab230875af5cce0dc4555cabc4760ef73c82f5fc7486f304fd0a4351e80a5f79701

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Compiled gems
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in scalingo-provider_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonathan Hurter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Scalingo::ProviderApi
+
+Ruby client for the Scalingo provider API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scalingo-provider_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scalingo-provider_api
+
+## Usage
+
+
+### Intialization
+
+```ruby
+client = Scalingo::ProviderApi::Client.new("user", "password")
+```
+
+### Find an app by id
+
+```ruby
+app = client.find_app "resource_id"
+```
+
+### Send configuration for an addon
+
+```ruby
+client.send_config "resource_id", {ENV_1: "VALUE", ENV_2: "VALUE2"}
+```
+
+### Provision an addon
+
+```ruby
+client.provision "resource_id"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Scalingo/scalingo-provider_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scalingo/provider_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/scalingo/provider_api.rb

@@ -0,0 +1,79 @@
+require 'scalingo/provider_api/version'
+require 'faraday'
+require 'json'
+
+module Scalingo
+  module ProviderApi
+    class Client
+      API_BASE_URL = 'https://api.scalingo.com/'.freeze
+
+      # Will define methods. The method will use the key as a name,
+      # and will be configured with the value.
+      #
+      # Value desc:
+      #  * method: HTTP method to call
+      #  * path: Parametrized url to call
+      #    Parameters can must be valid with the following regex: /:[a-z_]+/
+      #    The method will use arguments in the order of appeareance in the url
+      #  * body: should this method accept a body?
+      #  * body_hook; lambda function that will transform the body
+      METHODS = {
+        find_app: { method: :get, path: '/v1/provider/apps/:resource_id' },
+        send_config: { method: :patch, path: '/v1/provider/addons/:resource_id/config', body: true, body_hook: lambda {|b| {config: b}}},
+        provision: { method: :post, path: '/v1/provider/addons/:resource_id/actions/provision' }
+      }.freeze
+
+      def initialize(user, password, args = {})
+        @user = user
+        @password = password
+
+        @base_url = API_BASE_URL
+        @base_url = args[:base_url] if !args[:base_url].nil?
+      end
+
+      def method_missing(met, *a)
+        return if METHODS[met].nil?
+        desc = METHODS[met]
+        path = desc[:path]
+
+        # Find all arguments.
+        # http://a.fr/:a/b/:c/:a => [:a, :c]
+        args = path.scan(/:[a-z_]+/).uniq
+
+        # If we need a body add :body to the list of arguments
+        args << ":body" if desc[:body]
+
+        raise "Invalid arg count: #{a.length}, expected: #{args.length}" if args.length != a.length
+
+        args.each_with_index do |name, index|
+          old_name = name
+          name="@#{name[1..-1]}" # :abc => @abc
+
+          # Set an instance variable with the arg name
+          self.instance_variable_set name.to_s, a[index]
+
+          if name != "@body"
+            # Replace the variable name with its value in the path
+            path = path.gsub(old_name.to_s, self.instance_variable_get(name))
+          end
+        end
+
+        conn = Faraday.new url: @base_url do |c|
+          c.basic_auth(@user, @password)
+
+          c.use Faraday::Response::RaiseError
+          c.use Faraday::Adapter::NetHttp
+        end
+
+        @body = desc[:body_hook].call @body if !desc[:body_hook].nil?
+
+        res = conn.send(desc[:method], path) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.options.timeout = 30
+          req.body = @body.to_json
+        end
+        return JSON.parse res.body
+      end
+    end
+  end
+end

data/lib/scalingo/provider_api/version.rb

@@ -0,0 +1,5 @@
+module Scalingo
+  module ProviderApi
+    VERSION = "0.1.5"
+  end
+end

data/scalingo-provider_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "scalingo/provider_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "scalingo-provider_api"
+  spec.version       = Scalingo::ProviderApi::VERSION
+  spec.authors       = ["Jonathan Hurter"]
+  spec.email         = ["john@scalingo.com"]
+
+  spec.summary       = %q{Communication between a provider and Scalingo}
+  spec.description   = %q{A gem that implement the basic method to communicate between an addon provider and the Scalingo API}
+  spec.homepage      = "https://github.com/Scalingo/scalingo-provider-api-gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.1"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "webmock", "~> 3.1"
+  spec.add_development_dependency "pry", "~> 0.10"
+
+  spec.add_dependency "faraday", "~> 0.13.1"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: scalingo-provider_api
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Jonathan Hurter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: A gem that implement the basic method to communicate between an addon
+  provider and the Scalingo API
+email:
+- john@scalingo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/scalingo/provider_api.rb
+- lib/scalingo/provider_api/version.rb
+- scalingo-provider_api.gemspec
+homepage: https://github.com/Scalingo/scalingo-provider-api-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Communication between a provider and Scalingo
+test_files: []