rails_service_broker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31a62376238ea4d6d128c93c0299684d638ee91a
-  data.tar.gz: 50caf2a7fa37536055ef96023fdc016ca48725d7
+  metadata.gz: 2cf2be217815247f31b172b082aec798238cffed
+  data.tar.gz: acece6e790e4f8fed0f71b25cff7583fdc81d336
 SHA512:
-  metadata.gz: 33c5efd5dc2a70fc5586e305189205a390537f14b0c540b8d548f646f29debd7f320d32834f222d657488e84e67ef2982f1fc2498ca70883747bc21dadb509c7
-  data.tar.gz: 124a80dd9e923d4d3963a8551273189c997e3707d08faa0f898a5de2ac792f842946858f483d16f7ba409fb61fc3ca737bd03fdd2b6cf6dbb585ebcf9dd85f0b
+  metadata.gz: 279d64a5f8cc9382b0a3083bbe55d1b3deb5629cea510bba7ab46b5658779065aee0926315a2c50b892891711413f95acac389624491b4c1ca8c85f14748cf93
+  data.tar.gz: 8375b4355d80fbdbb1723a7a226b01407cb118b05e3bc558e6f484a040538ae43739b4630ec9af992109bbdd089d355267e9c56753b34dd9de7b513a889f296d

data/lib/generators/rails_service_broker/api_generator.rb

@@ -3,13 +3,16 @@ module RailsServiceBroker
     source_root File.expand_path('../../templates', __FILE__)
     argument :api_version, type: :string, default: "v2"
     argument :api_dir, type: :string, default: "apis"
+    argument :service_id, default: SecureRandom.uuid
+    argument :plan_id, default: SecureRandom.uuid
 
-    def add_template_grape_files
+    def add_template_grape_files_and_spec
       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"
+      template "specs/#{api_version}/service_broker_api_spec.rb", "spec/requests/#{api_dir}/#{plural_name.singularize}/#{api_version}/service_broker_api_spec.rb"
     end
 
     def add_template_service_yaml

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

@@ -2,7 +2,7 @@ module <%= plural_name.singularize.classify %>
   module V2
     class Catalog < Grape::API
       resource :catalog do
-        desc 'GET /v2/catalog'
+        desc 'GET /<%= plural_name.singularize %>/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

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

@@ -4,7 +4,7 @@ module <%= plural_name.singularize.classify %>
       resource :service_instances do
         route_param :instance_id do
           resource :service_bindings do
-            desc 'PUT /v2/service_instances/:instance_id/service_bindings/:binding_id'
+            desc 'PUT /<%= plural_name.singularize %>/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.
@@ -12,14 +12,21 @@ module <%= plural_name.singularize.classify %>
             # 422 Unprocessable Entity
             put '/:binding_id' do
               # TODO Write code to return HTTP status code for create service binding result.
+              return {
+                credentials: {
+                },
+                syslog_drain_url: "http://syslog_drain_url", # this parameter is optional.
+                route_service_url: "http://route_service_url" # If you create route service broker, this parameter must be need.
+              }
             end
 
-            desc 'DELETE /v2/service_instances/:instance_id/service_bindings/:binding_id'
+            desc 'DELETE /<%= plural_name.singularize %>/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
+            delete '/:binding_id' do
               # TODO Write code to return HTTP status code for delete service binding result.
+              return { }
             end
           end
         end

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

@@ -2,32 +2,42 @@ module <%= plural_name.singularize.classify %>
   module V2
     class ServiceInstance < Grape::API
       resource :service_instances do
-        desc 'PUT /v2/service_instances/:instance_id'
+        desc 'PUT /<%= plural_name.singularize %>/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
+          return {
+            dashboard_url: "http://path.to/dashboard_url",
+            operation: "create in progress" # TODO 'operation' field is optional.
+          }
         end
 
-        desc 'GET /v2/service_instances/:instance_id/last_opration'
+        desc 'GET /<%= plural_name.singularize %>/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)
+          return {
+            operation: "create in progress" # TODO 'operation' field is optional
+          }
         end
 
-        desc 'PATCH /v2/service_instances/:instance_id'
+        desc 'PATCH /<%= plural_name.singularize %>/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)
+          return {
+            operation: "update in progress" # TODO 'operation' field is optional
+          }
         end
 
-        desc 'DELETE /v2/service_instances/:instance_id'
+        desc 'DELETE /<%= plural_name.singularize %>/v2/service_instances/:instance_id'
         # Deprovisioning
         # 200 OK Service instance was deleted.
         # 202 Accepted Service instance deletion is in progress.
@@ -35,6 +45,9 @@ module <%= plural_name.singularize.classify %>
         # 422 Unprocessable Entity
         delete '/:instance_id' do
           # TODO Write code to return HTTP status code for delete service instance
+          return {
+            operation: "delete in progress" # TODO 'operation' field is optional
+          }
         end
       end
     end

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

@@ -1,6 +1,6 @@
 services:
   - name: "TODO: Put your service"
-    id: "<%= SecureRandom.uuid %>"
+    id: "<%= service_id %>"
     description: "TODO: Put your description"
     tags: "TODO: Put your service type"
     requires: ""
@@ -15,19 +15,22 @@ services:
       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
+        id: 'TODO: Add client id when you would like to provide dashboard client'
+        secret: 'TODO: Add client secret when you would like to provide dashboard client'
+        redirect_uri: 'TODO: http://path.to/dashboard/oauth_endpoint'
+    plan_updateable: true
+    plans:
+      - name: "TODO: Add your plan"
+        id: "<%= plan_id %>"
+        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/specs/v2/service_broker_api_spec.rb

@@ -0,0 +1,80 @@
+require 'rails_helper'
+
+RSpec.describe "ServiceBrokerApis", type: :request do
+  describe "GET /<%= plural_name.singularize %>/v2/catalog" do
+    subject { get "/<%= plural_name.singularize %>/v2/catalog" }
+
+    it "works! (now write some real specs)" do
+      subject
+      expect(response).to have_http_status(200)
+    end
+  end
+
+  describe "PUT /<%= plural_name.singularize %>/v2/service_instances/:instance_id" do
+    let(:instance_id) { SecureRandom.uuid }
+    let(:organization_guid) { SecureRandom.uuid }
+    let(:space_guid) { SecureRandom.uuid }
+    let(:parameters) { { } }
+
+    subject do
+      put "/<%= plural_name.singularize %>/v2/service_instances/#{instance_id}",
+        params: { organization_guid: organization_guid,
+                  plan_id: "<%= service_id %>",
+                  service_id: "<%= plan_id %>",
+                  space_guid: space_guid,
+                  parameters: parameters }
+    end
+
+    it "return json with dashbaord_url" do
+      subject
+      json = JSON.parse(response.body)
+      expect(json["dashboard_url"]).to eq("http://path.to/dashboard_url")
+    end
+  end
+
+  describe "DELETE /<%= plural_name.singularize %>/v2/service_instances/:instance_id" do
+    let(:instance_id) { SecureRandom.uuid }
+    subject do
+      delete "/<%= plural_name.singularize %>/v2/service_instances/#{instance_id}",
+        params: {
+          service_id: "<%= service_id %>",
+          plan_id: "<%= plan_id %>"
+        }
+    end
+    it{ subject; expect(response.status).to eq(200) }
+    it{ subject; expect(response.body).to eq("{}") }
+  end
+
+  describe "PUT /<%= plural_name.singularize %>/v2/service_instances/:instance_id/service_bindings/:binding_id" do
+    let(:instance_id){ SecureRandom.uuid }
+    let(:app_guid){ SecureRandom.uuid }
+    let(:binding_id){ SecureRandom.uuid }
+
+    subject do
+      put "/<%= plural_name.singularize %>/v2/service_instances/#{instance_id}/service_bindings/#{binding_id}",
+        params: {
+          service_id: "<%= service_id %>",
+          plan_id: "<%= plan_id %>",
+          app_guid: app_guid
+        }
+    end
+
+    it{ subject; expect(response.status).to eq(200) }
+  end
+
+  describe "DELETE /v2/service_instances/:instance_id/service_bindings/:binding_id" do
+    let(:instance_id){ SecureRandom.uuid }
+    let(:binding_id){ SecureRandom.uuid }
+
+    subject do
+      delete "/<%= plural_name.singularize %>/v2/service_instances/#{instance_id}/service_bindings/#{binding_id}",
+        params: {
+          service_id: "<%= service_id %>",
+          plan_id: "<%= plan_id %>"
+        }
+    end
+
+    it{ subject; expect(response.status).to eq(200) }
+  end
+end
+

data/lib/rails_service_broker.rb

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

data/lib/rails_service_broker/return_codes.rb

@@ -0,0 +1,8 @@
+module RailsServiceBroker
+  OK                   = 200
+  CREATED              = 201
+  ACCEPTED             = 202
+  CONFLICT             = 409
+  GONE                 = 410
+  UNPROCESSABLE_ENTITY = 422
+end

data/lib/rails_service_broker/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_service_broker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Toshio Maki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -104,9 +104,11 @@ files:
 - 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/specs/v2/service_broker_api_spec.rb
 - lib/generators/templates/views/v2/catalog.json.jbuilder
 - lib/rails_service_broker.rb
 - lib/rails_service_broker/engine.rb
+- lib/rails_service_broker/return_codes.rb
 - lib/rails_service_broker/version.rb
 - rails_service_broker.gemspec
 homepage: https://github.com/kirikak2/rails_service_broker