rails_service_broker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31a62376238ea4d6d128c93c0299684d638ee91a
+  data.tar.gz: 50caf2a7fa37536055ef96023fdc016ca48725d7
+SHA512:
+  metadata.gz: 33c5efd5dc2a70fc5586e305189205a390537f14b0c540b8d548f646f29debd7f320d32834f222d657488e84e67ef2982f1fc2498ca70883747bc21dadb509c7
+  data.tar.gz: 124a80dd9e923d4d3963a8551273189c997e3707d08faa0f898a5de2ac792f842946858f483d16f7ba409fb61fc3ca737bd03fdd2b6cf6dbb585ebcf9dd85f0b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_service_broker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Toshio Maki
+
+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,48 @@
+# Rails Service Broker
+
+Very simple solution for create service broker on Ruby on Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_service_broker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_service_broker
+
+## Usage
+
+When you would like to create AwesomeService ServiceBroker, you can write this.
+
+```
+# rails g rails_service_broker:api awesome_service
+      create  app/apis/awesome_service/base.rb
+      create  app/apis/awesome_service/v2/base.rb
+      create  app/apis/awesome_service/v2/catalog.rb
+      create  app/apis/awesome_service/v2/service_binding.rb
+      create  app/apis/awesome_service/v2/service_instance.rb
+      create  config/awesome_service.yml
+      create  app/views/api/awesome_service/v2/catalog.json.jbuilder
+       route  mount AwesomeService::Base => '/awesome_service'
+```
+
+Service Broker Endpoint is create at `http://localhost:3000/awesome_service/` enjoy!
+
+You have to edit `config/awesome_service.yml` for define service.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kirikak2/rails_service_broker.
+
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_service_broker"
+
+# 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
+
+require "irb"
+IRB.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/config/initializers/rails_service_broker.rb

@@ -0,0 +1,4 @@
+Rails.application.config.autoload_paths += Dir[Rails.root.join('app', 'apis', '*')]
+Rails.application.config.middleware.use(Rack::Config) do |env|
+  env['api.tilt.root'] = Rails.root.join('app', 'views', 'api')
+end

data/lib/generators/rails_service_broker/api_generator.rb

@@ -0,0 +1,27 @@
+module RailsServiceBroker
+  class ApiGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../../templates', __FILE__)
+    argument :api_version, type: :string, default: "v2"
+    argument :api_dir, type: :string, default: "apis"
+
+    def add_template_grape_files
+      template "apis/base.rb", "app/#{api_dir}/#{plural_name.singularize}/base.rb"
+      template "apis/#{api_version}/base.rb", "app/#{api_dir}/#{plural_name.singularize}/#{api_version}/base.rb"
+      template "apis/#{api_version}/catalog.rb", "app/#{api_dir}/#{plural_name.singularize}/#{api_version}/catalog.rb"
+      template "apis/#{api_version}/service_binding.rb", "app/#{api_dir}/#{plural_name.singularize}/#{api_version}/service_binding.rb"
+      template "apis/#{api_version}/service_instance.rb", "app/#{api_dir}/#{plural_name.singularize}/#{api_version}/service_instance.rb"
+    end
+
+    def add_template_service_yaml
+      template "config/service.yml", "config/#{plural_name.singularize}_service.yml"
+    end
+
+    def add_template_jbuilder_files
+      template "views/#{api_version}/catalog.json.jbuilder", "app/views/api/#{plural_name.singularize}/v2/catalog.json.jbuilder"
+    end
+
+    def add_routes
+      route "mount #{plural_name.singularize.classify}::Base => '/#{plural_name.singularize}'"
+    end
+  end
+end

data/lib/generators/templates/apis/base.rb

@@ -0,0 +1,5 @@
+module <%= plural_name.singularize.classify %>
+  class Base < Grape::API
+    mount V2::Base
+  end
+end

data/lib/generators/templates/apis/v2/base.rb

@@ -0,0 +1,13 @@
+module <%= plural_name.singularize.classify %>
+  module V2
+    class Base < Grape::API
+      version '<%= api_version %>'
+      format :json
+      formatter :json, Grape::Formatter::Jbuilder
+
+      mount Catalog
+      mount ServiceBinding
+      mount ServiceInstance
+    end
+  end
+end

data/lib/generators/templates/apis/v2/catalog.rb

@@ -0,0 +1,13 @@
+module <%= plural_name.singularize.classify %>
+  module V2
+    class Catalog < Grape::API
+      resource :catalog do
+        desc 'GET /v2/catalog'
+        get '/', jbuilder: '<%= plural_name.singularize %>/v2/catalog.json' do
+          @services = YAML.load_file(File.join(Rails.root, 'config', '<%= plural_name.singularize %>_service.yml'))
+        end
+      end
+    end
+  end
+end
+

data/lib/generators/templates/apis/v2/service_binding.rb

@@ -0,0 +1,29 @@
+module <%= plural_name.singularize.classify %>
+  module V2
+    class ServiceBinding < Grape::API
+      resource :service_instances do
+        route_param :instance_id do
+          resource :service_bindings do
+            desc 'PUT /v2/service_instances/:instance_id/service_bindings/:binding_id'
+            # Bind service
+            # 201 Created Binding has been created.
+            # 200 OK the binding already exists and requested parameters are identical to the existing binding.
+            # 409 Conflict the requested binding already exists.
+            # 422 Unprocessable Entity
+            put '/:binding_id' do
+              # TODO Write code to return HTTP status code for create service binding result.
+            end
+
+            desc 'DELETE /v2/service_instances/:instance_id/service_bindings/:binding_id'
+            # Unbinding service
+            # 200 OK Binding was deleted.
+            # 410 Gone Binding does not exist.
+            put '/:binding_id' do
+              # TODO Write code to return HTTP status code for delete service binding result.
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/apis/v2/service_instance.rb

@@ -0,0 +1,42 @@
+module <%= plural_name.singularize.classify %>
+  module V2
+    class ServiceInstance < Grape::API
+      resource :service_instances do
+        desc 'PUT /v2/service_instances/:instance_id'
+        # Catalog Management
+        # Status Code
+        # 200 OK The expected response body is below.
+        put '/:instance_id' do
+          # TODO Write code to return HTTP status code for create service instance
+        end
+
+        desc 'GET /v2/service_instances/:instance_id/last_opration'
+        # Polling Last Operation(async only)
+        # 200 OK The expected response body is below.
+        # 410 GONE Appropriate only for asynchronous delete requests.
+        get '/:instance_id/last_operation' do
+          # TODO Write code to return HTTP status code for create service progress(optional)
+        end
+
+        desc 'PATCH /v2/service_instances/:instance_id'
+        # Updating a Service Instance
+        # 200 OK New plan is effective.
+        # 202 Accepted Service instance update is in progress.
+        # 422 Unprocessable entity May be returned if the particular plan change requested is not supported.
+        patch '/:instance_id' do
+          # TODO Write code to return HTTP status code for update service instance(optional)
+        end
+
+        desc 'DELETE /v2/service_instances/:instance_id'
+        # Deprovisioning
+        # 200 OK Service instance was deleted.
+        # 202 Accepted Service instance deletion is in progress.
+        # 410 Gone The service instance does not exist.
+        # 422 Unprocessable Entity
+        delete '/:instance_id' do
+          # TODO Write code to return HTTP status code for delete service instance
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/config/service.yml

@@ -0,0 +1,33 @@
+services:
+  - name: "TODO: Put your service"
+    id: "<%= SecureRandom.uuid %>"
+    description: "TODO: Put your description"
+    tags: "TODO: Put your service type"
+    requires: ""
+    bindable: true
+    metadata:
+      name: "TODO: A short name for the service to be displayed"
+      description: "TODO: A short-1-line description for the service"
+      displayName: "TODO: The name of the service to be displayed in graphical clients"
+      imageUrl: "TODO: The URL to an image"
+      longDescription: "TODO: Long description"
+      providerDisplayName: "TODO: The name of the upstream entity providing the actual service"
+      documentationUrl: "TODO: Link to documentation page for service"
+      supportUrl: "TODO: Link to support for the service"
+      dashboard_client: 
+      plan_updateable: true
+      plans:
+        - name: "TODO: Add your plan"
+          id: "<%= SecureRandom.uuid %>"
+          description: "TODO: A short description of the service that will appear in the catalog"
+          metadata:
+            name: "TODO: A short name for the service plan to be displayed in a catalog"
+            description: "TODO: A description of the service plan to be displayed in a catalog"
+            bullets:
+              - "TODO: Features of this plan, to be displayed in a bulleted-list"
+            costs:
+              amount:
+                usd: 0
+              unit: "MONTHLY"
+            displayName: "TODO: Name of the plan to be display in graphical clients"
+          free: true

data/lib/generators/templates/views/v2/catalog.json.jbuilder

@@ -0,0 +1,2 @@
+json.ignore_nil!
+json.merge! @services

data/lib/rails_service_broker/engine.rb

@@ -0,0 +1,5 @@
+module RailsServiceBroker
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsServiceBroker
+  end
+end

data/lib/rails_service_broker/version.rb

@@ -0,0 +1,3 @@
+module RailsServiceBroker
+  VERSION = "0.1.0"
+end

data/lib/rails_service_broker.rb

@@ -0,0 +1,5 @@
+require "rails_service_broker/version"
+require "rails_service_broker/engine"
+
+require 'grape'
+require 'grape/jbuilder'

data/rails_service_broker.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_service_broker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_service_broker"
+  spec.version       = RailsServiceBroker::VERSION
+  spec.authors       = ["Toshio Maki"]
+  spec.email         = ["toshio.maki.yy@hitachi-solutions.com"]
+
+  spec.summary       = %q{Generate service broker template for Cloud Foundry}
+  spec.description   = %q{This gem is generate api template for Cloud Foundry Service Broker API.}
+  spec.homepage      = %q{https://github.com/kirikak2/rails_service_broker}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "grape"
+  spec.add_dependency "grape-jbuilder"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: rails_service_broker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toshio Maki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape-jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem is generate api template for Cloud Foundry Service Broker API.
+email:
+- toshio.maki.yy@hitachi-solutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/initializers/rails_service_broker.rb
+- lib/generators/rails_service_broker/api_generator.rb
+- lib/generators/templates/apis/base.rb
+- lib/generators/templates/apis/v2/base.rb
+- lib/generators/templates/apis/v2/catalog.rb
+- lib/generators/templates/apis/v2/service_binding.rb
+- lib/generators/templates/apis/v2/service_instance.rb
+- lib/generators/templates/config/service.yml
+- lib/generators/templates/views/v2/catalog.json.jbuilder
+- lib/rails_service_broker.rb
+- lib/rails_service_broker/engine.rb
+- lib/rails_service_broker/version.rb
+- rails_service_broker.gemspec
+homepage: https://github.com/kirikak2/rails_service_broker
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Generate service broker template for Cloud Foundry
+test_files: []