diesel-api-dsl 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c09f2251953d171164fa4883b9aad83e9a1d7d9
-  data.tar.gz: 7c885dc69abd71c3e3c897e20bfcbf5ca141c166
+  metadata.gz: 5205a50b3bdbd62a8a5dd19471fe81656a943b82
+  data.tar.gz: 45e98aae757b989153b9323ec7d670234a14ed83
 SHA512:
-  metadata.gz: 8347d51bde9ca019c77d813ce453199603736228b00e69294bc4af670959101b978218d39bf18ef1f7b04afdfe2483d7b2fae19eb9bde26f51c528592d442496
-  data.tar.gz: b67551247eab1cde0aa09fb14f34f60e1d6e4824d1d4016eae690d3f34d92662b1d2e738e032a81b33295151a59613e021ba43d5ae0d7135c857093f9d86f1ba
+  metadata.gz: ade33fbdca31713aba34eb525aa4ba89825875b0b9e6a0d073bf58b38762734f886cfe3f2818f80b7efb317440106c148af5cf930c8b9f70744fde7004697717
+  data.tar.gz: 1d89e1a7bafc5ab3f8ffd4ab3e754ad9a50adcf50e6ca6e757ac6a3c25069363445caa64442b803d711289aa4fc95df11d7a6f58001d28a932b7709798c28035

data/README.md

@@ -1,12 +1,12 @@
 # Diesel
 
-Create API Clients From an DSL
+Create API Clients from Swagger specifications
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'diesel'
+    gem 'diesel-api-dsl'
 
 And then execute:
 
@@ -18,7 +18,16 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+PivotalTracker = Diesel.load_path("pivotal_tracker.json")
+client = PivotalTracker.new(api_token: 'afaketoken')
+client.create_story(
+  project_id: '1234567',
+  story: {
+    name: 'Testing Pivotal API',
+    story_type: :chore
+  })
+```
 
 ## Contributing
 

data/lib/diesel/api_builder.rb

@@ -1,3 +1,4 @@
+require 'diesel/version'
 require 'diesel/api_error'
 require 'diesel/utils/inflections'
 require 'diesel/api_base'
@@ -73,6 +74,8 @@ module Diesel
               endpoint.config_middleware do
                 use Diesel::Middleware::Debug
 
+                use Diesel::Middleware::SetHeader, 'User-Agent' => "diesel-rb/#{Diesel::VERSION}"
+
                 if spec.produces.any?
                   use Diesel::Middleware::SetHeader, 'Content-Type' => spec.produces.first
                 end
@@ -85,6 +88,10 @@ module Diesel
                         id: Diesel::Utils::Inflections.underscore(name).to_sym,
                         in: security_def.in,
                         name: security_def.name
+                  when 'oauth2'
+                    require 'diesel/middleware/auth/oauth2'
+                    use Diesel::Middleware::Auth::OAuth2,
+                        id: Diesel::Utils::Inflections.underscore(name).to_sym
                   else
                     raise APIError, "Unsupported security definition: #{security_def.type}"
                   end

data/lib/diesel/middleware/auth/oauth2.rb

@@ -0,0 +1,24 @@
+module Diesel
+  module Middleware
+    module Auth
+      class OAuth2
+
+        AUTHORIZATION_HEADER = 'Authorization'
+        AUTHORIZATION_HEADER_FORMAT = 'Bearer %s'
+
+        def initialize(app, options)
+          @app = app
+          @id = options[:id]
+        end
+
+        def call(env)
+          context = env[:context]
+          auth_options = context.options[@id]
+          env[:request_headers][AUTHORIZATION_HEADER] = AUTHORIZATION_HEADER_FORMAT % auth_options[:token]
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/diesel/swagger/data_type_field.rb

@@ -17,9 +17,9 @@ module Diesel
       attribute :max_items
       attribute :min_items
       attribute :unique_items, type: :boolean
+      attribute :items
 
       list :enum
-      list :items
     end
   end
 end

data/lib/diesel/swagger/definition.rb

@@ -4,9 +4,17 @@ require 'diesel/swagger/property'
 module Diesel
   module Swagger
     class Definition < Node
+      attr_reader :id
+
       attribute :required
       attribute :discriminator
+
       hash :properties
+
+      def initialize(id)
+        super()
+        @id = id
+      end
     end
   end
 end

data/lib/diesel/swagger/node.rb

@@ -130,6 +130,11 @@ module Diesel
         h
       end
 
+      def to_json
+        MultiJson.dump(serializable_hash)
+      end
+      alias :to_s :to_json
+
       private
 
         def value_or_serializable_hash(v)

data/lib/diesel/swagger/operation.rb

@@ -4,6 +4,9 @@ require 'diesel/swagger/parameter'
 module Diesel
   module Swagger
     class Operation < Node
+      attr_reader :id
+      alias :method_name :id
+
       attribute :summary
       attribute :description
       attribute :external_docs, validate: true
@@ -17,6 +20,11 @@ module Diesel
       list :responses, validate: true
       list :schemes
       list :security, validate: true
+
+      def initialize(id)
+        super()
+        @id = id
+      end
     end
   end
 end

data/lib/diesel/swagger/parser.rb

@@ -18,20 +18,26 @@ module Diesel
         specification.external_docs = build_node(ExternalDocs, json['externalDocs'])
         specification.schemes = json['schemes']
         specification.produces = json['produces'] || []
-        specification.security_definitions = build_node_hash(Swagger::SecurityDefinition, json, 'securityDefinitions')
+        specification.security_definitions = build_node_hash(SecurityDefinition, json, 'securityDefinitions')
+        specification.security = (json['security'] || {}).reduce({}) do |memo, (k,v)|
+          memo[k] = security = Security.new(k)
+          security.scopes = v
+          memo
+        end
         specification.paths = build_node_hash(Path, json, 'paths') do |path, path_json|
           [:get, :put, :post, :delete, :options, :head, :patch].each do |method|
             if op_json = path_json[method.to_s]
-              op = build_node(Operation, op_json)
+              op = build_node(Operation, op_json, constructor_args: [method])
               op.external_docs = build_node(ExternalDocs, op_json['externalDocs'])
               op.parameters = build_node_list(Parameter, op_json, 'parameters')
               path.send("#{method}=".to_sym, op)
             end
           end
         end
-        specification.definitions = build_node_hash(Swagger::Definition, json, 'definitions') do |definition, def_json|
-          definition.properties = build_node_hash(Swagger::Property, def_json, 'properties') do |prop, prop_json|
+        specification.definitions = build_node_hash(Definition, json, 'definitions') do |definition, def_json|
+          definition.properties = build_node_hash(Property, def_json, 'properties') do |prop, prop_json|
             prop.enum = prop_json['enum']
+            prop.items = prop_json['items']
           end
         end
         specification
@@ -39,9 +45,13 @@ module Diesel
 
       protected
 
-        def build_node(model_class, json)
+        def build_node(model_class, json, options = {})
           if json
-            model = model_class.new
+            model = if constructor_args = options[:constructor_args]
+              model_class.new(*constructor_args)
+            else
+              model_class.new
+            end
             model_class.attribute_names.each do |att|
               model.send("#{att}=".to_sym, json[camelize(att.to_s, false)])
             end
@@ -59,7 +69,7 @@ module Diesel
 
         def build_node_hash(model_class, json, json_hash_key)
           (json[json_hash_key] || {}).reduce({}) do |m, (k, v)|
-            m[k] = node = build_node(model_class, v)
+            m[k] = node = build_node(model_class, v, constructor_args: [k])
             yield(node, v) if block_given?
             m
           end

data/lib/diesel/swagger/path.rb

@@ -4,18 +4,28 @@ require 'diesel/swagger/operation'
 module Diesel
   module Swagger
     class Path < Node
-      attribute :get, validate: true
-      attribute :put, validate: true
-      attribute :post, validate: true
-      attribute :delete, validate: true
-      attribute :options, validate: true
-      attribute :head, validate: true
-      attribute :patch, validate: true
+      attr_reader :id
+      alias :path_name :id
+
+      REQUEST_METHODS = [:get, :put, :post, :delete, :options, :head, :patch]
+
+      REQUEST_METHODS.each do |m|
+        attribute m, validate: true
+      end
 
       list :parameters, validate: true
 
+      def initialize(id)
+        super()
+        @id = id
+      end
+
+      def operations
+        REQUEST_METHODS.map { |m| __send__(m) }.compact
+      end
+
       def operations_map
-        [:get, :put, :post, :delete, :options, :head, :patch].reduce({}) do |m, method|
+        REQUEST_METHODS.reduce({}) do |m, method|
           if op = __send__(method)
             m[method] = op
           end

data/lib/diesel/swagger/property.rb

@@ -3,6 +3,13 @@ require 'diesel/swagger/data_type_field'
 module Diesel
   module Swagger
     class Property < DataTypeField
+      attr_reader :id
+
+      def initialize(id)
+        super()
+        @id = id
+      end
+
     end
   end
 end

data/lib/diesel/swagger/security.rb

@@ -0,0 +1,21 @@
+require 'diesel/swagger/node'
+
+module Diesel
+  module Swagger
+    class Security < Node
+      attr_reader :id
+
+      attribute :scopes
+
+      def initialize(id)
+        super()
+        @id = id
+      end
+
+      def serializable_hash
+        scopes || []
+      end
+
+    end
+  end
+end

data/lib/diesel/swagger/security_definition.rb

@@ -3,6 +3,8 @@ require 'diesel/swagger/node'
 module Diesel
   module Swagger
     class SecurityDefinition < Node
+      attr_reader :id
+
       attribute :type
       attribute :description
       attribute :name
@@ -10,6 +12,11 @@ module Diesel
       attribute :flow
       attribute :authorization_url
       attribute :token_url
+
+      def initialize(id)
+        super()
+        @id = id
+      end
     end
   end
 end

data/lib/diesel/swagger/specification.rb

@@ -1,5 +1,6 @@
 require 'diesel/swagger/info'
 require 'diesel/swagger/external_docs'
+require 'diesel/swagger/security'
 require 'diesel/swagger/security_definition'
 require 'diesel/swagger/path'
 require 'diesel/swagger/definition'
@@ -24,7 +25,7 @@ module Diesel
       hash :parameters, validate: true
       hash :responses, validate: true
       hash :security_definitions, validate: true
-      hash :security
+      hash :security, validate: true
     end
   end
 end

data/lib/diesel/version.rb

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

data/spec/diesel/swagger/parser_spec.rb

@@ -4,12 +4,12 @@ require 'diesel/swagger/parser'
 describe Diesel::Swagger::Parser do
   subject { Diesel::Swagger::Parser }
 
-  let(:specification_json) do
-    File.read(File.join(File.dirname(__FILE__), '..', '..', 'files', 'pivotal_tracker.json'))
+  def load_spec(name)
+    File.read(File.join(File.dirname(__FILE__), '..', '..', 'files', "#{name}.json"))
   end
 
-  it "should parse a diesel specification" do
-    specification = Diesel::Swagger::Parser.new.parse(specification_json)
+  it "should parse a swagger specification" do
+    specification = Diesel::Swagger::Parser.new.parse(load_spec('pivotal_tracker'))
     expect(specification).to_not be_nil
 
     expect(specification.host).to eq "www.pivotaltracker.com"
@@ -23,9 +23,12 @@ describe Diesel::Swagger::Parser do
     api_token = specification.security_definitions['apiToken']
     expect(api_token).to_not be_nil
     expect(api_token.type).to eq "apiKey"
-    expect(api_token.in).to eq "header"
+    expect(api_token.in).to eq :header
     expect(api_token.name).to eq "X-TrackerToken"
 
+    security = specification.security['apiToken']
+    expect(security).to_not be_nil
+
     expect(specification.produces).to include "application/json"
 
     expect(specification.paths.count).to eq 1
@@ -48,7 +51,7 @@ describe Diesel::Swagger::Parser do
     param2 = path.post.parameters[1]
     expect(param2).to_not be_nil
     expect(param2.in).to eq :body
-    expect(param2.name).to eq "body"
+    expect(param2.name).to eq "story"
     expect(param2).to be_required
     expect(param2.schema).to eq "NewStory"
 
@@ -77,4 +80,14 @@ describe Diesel::Swagger::Parser do
       "unscheduled"
     ]
   end
+
+  it "should parse a swagger specification with an array of schema objects" do
+    specification = Diesel::Swagger::Parser.new.parse(load_spec('slack'))
+    payload = specification.definitions["Payload"]
+
+    attachments_prop = payload.properties['attachments']
+    expect(attachments_prop.type).to eq :array
+    expect(attachments_prop.items.count).to eq 1
+    expect(attachments_prop.items["$ref"]).to eq '#/definitions/Attachment'
+  end
 end

data/spec/diesel/swagger/specification_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'diesel/swagger/specification'
+
+describe Diesel::Swagger::Specification do
+
+  it "should serialize security node as key and scopes" do
+    spec = described_class.new
+
+    security = Diesel::Swagger::Security.new('oauth')
+    security.scopes = ['email']
+    spec.security = { 'oauth' => security }
+
+    hash = spec.serializable_hash
+    security_hash = hash['security'] 
+    expect(security_hash).to_not be_nil
+    scopes = security_hash['oauth']
+    expect(scopes).to eq ['email']
+  end
+end

data/spec/diesel_spec.rb

@@ -40,4 +40,38 @@ describe Diesel do
       expect(results.response.code).to eq "200"
     end
   end
+
+  it "should be able to build a Slack API client" do
+    Slack = load_api('slack')
+    client = Slack.new
+    client.logger = Logger.new(STDOUT)
+    client.logger.level = Logger::DEBUG
+
+    VCR.use_cassette('slack') do
+      results = client.post_message(path: 'abcd/efgh/ijkl',
+                                    payload: {
+                                      text: 'Testing',
+                                      username: 'TestBot',
+                                      attachments: [
+                                        {
+                                          fallback: "test fallback text",
+                                          text: "test text",
+                                          pretext: "test pretext",
+                                          fields: [
+                                            {
+                                              title: "test field 1",
+                                              value: "test value 1"
+                                            },
+                                            {
+                                              title: "test field 2",
+                                              value: "test value 2"
+                                            }
+                                          ]
+                                        }
+                                      ]
+                                    })
+      expect(results.response.code).to eq "200"
+      expect(results.parsed_response).to eq "ok"
+    end
+  end
 end

data/spec/files/slack.json

@@ -0,0 +1,88 @@
+{
+  "swagger": "2.0",
+
+  "info": {
+    "title": "Slack",
+    "description": "Slack Incoming Webhook",
+    "version": "1"
+  },
+
+  "host": "hooks.slack.com",
+
+  "basePath": "/services",
+
+  "schemes": ["https"],
+
+  "produces": ["application/json"],
+
+  "paths": {
+    "/{path}": {
+      "post": {
+        "summary": "Post message into Slack",
+        "operationId": "postMessage",
+        "parameters": [
+          {
+            "name": "path",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "payload",
+            "in": "body",
+            "required": true,
+            "schema": "Payload"
+          }
+        ]
+      }
+    }
+  },
+
+  "definitions": {
+    "Payload": {
+      "title": "Payload",
+      "type": "object",
+      "required": [ "text" ],
+      "properties": {
+        "text": { "type": "string" },
+        "username": { "type": "string" },
+        "icon_url": { "type": "string" },
+        "icon_emoji": { "type": "string" },
+        "channel": { "type": "string" },
+        "attachments": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Attachment"
+          }
+        }
+      }
+    },
+    "Attachment": {
+      "title": "Attachment",
+      "type": "object",
+      "required": ["fallback"],
+      "properties": {
+        "fallback": { "type": "string" },
+        "text": { "type": "string" },
+        "pretext": { "type": "string" },
+        "color": { "type": "string" },
+        "fields": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/AttachmentField"
+          }
+        }
+      },
+      "AttachmentField": {
+        "title": "Attachment Field",
+        "type": "object",
+        "required": ["title"],
+        "properties": {
+          "title": { "type": "string" },
+          "value": { "type": "string" },
+          "short": { "type": "boolean" }
+        }
+      }
+    }
+  }
+}

data/spec/fixtures/vcr_cassettes/slack.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://hooks.slack.com/services/abcd/efgh/ijkl
+    body:
+      encoding: UTF-8
+      string: '{"text":"Testing","username":"TestBot","attachments":[{"fallback":"test
+        fallback text","text":"test text","pretext":"test pretext","fields":[{"title":"test
+        field 1","value":"test value 1"},{"title":"test field 2","value":"test value
+        2"}]}]}'
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - text/html
+      Date:
+      - Sun, 04 Jan 2015 21:21:29 GMT
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      Content-Length:
+      - '2'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ok
+    http_version:
+  recorded_at: Sun, 04 Jan 2015 21:21:29 GMT
+recorded_with: VCR 2.9.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diesel-api-dsl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Calvin Yu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-04 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,9 +120,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- apis/slack.rb
 - diesel.gemspec
-- examples/post_slack_message.rb
 - lib/diesel.rb
 - lib/diesel/api_base.rb
 - lib/diesel/api_builder.rb
@@ -131,6 +129,7 @@ files:
 - lib/diesel/data_model.rb
 - lib/diesel/endpoint.rb
 - lib/diesel/middleware/auth/api_key.rb
+- lib/diesel/middleware/auth/oauth2.rb
 - lib/diesel/middleware/debug.rb
 - lib/diesel/middleware/set_body_parameter.rb
 - lib/diesel/middleware/set_header.rb
@@ -150,17 +149,21 @@ files:
 - lib/diesel/swagger/parser.rb
 - lib/diesel/swagger/path.rb
 - lib/diesel/swagger/property.rb
+- lib/diesel/swagger/security.rb
 - lib/diesel/swagger/security_definition.rb
 - lib/diesel/swagger/specification.rb
 - lib/diesel/utils/inflections.rb
 - lib/diesel/version.rb
 - spec/diesel/api_builder_spec.rb
 - spec/diesel/swagger/parser_spec.rb
+- spec/diesel/swagger/specification_spec.rb
 - spec/diesel_spec.rb
 - spec/files/honeybadger.json
 - spec/files/pivotal_tracker.json
+- spec/files/slack.json
 - spec/fixtures/vcr_cassettes/honeybadger.yml
 - spec/fixtures/vcr_cassettes/pivotal_tracker_create_story.yml
+- spec/fixtures/vcr_cassettes/slack.yml
 - spec/spec_helper.rb
 homepage: http://github.com/cyu/diesel
 licenses:
@@ -182,16 +185,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Create API Clients From an DSL
 test_files:
 - spec/diesel/api_builder_spec.rb
 - spec/diesel/swagger/parser_spec.rb
+- spec/diesel/swagger/specification_spec.rb
 - spec/diesel_spec.rb
 - spec/files/honeybadger.json
 - spec/files/pivotal_tracker.json
+- spec/files/slack.json
 - spec/fixtures/vcr_cassettes/honeybadger.yml
 - spec/fixtures/vcr_cassettes/pivotal_tracker_create_story.yml
+- spec/fixtures/vcr_cassettes/slack.yml
 - spec/spec_helper.rb

data/apis/slack.rb

@@ -1,36 +0,0 @@
-apis do
-  description "Slack"
-  api_version "1"
-  base_path "https://scoutmob.slack.com/services/hooks"
-
-  api_key "token" do
-    nickname :api_token
-    pass_as :query_parameter
-  end
-
-  header "Content-Type" => "application/json"
-
-  resource "incoming-webhook" do
-    description "Incoming Webhook"
-
-    operation :send_message do
-      reference_url "https://my.slack.com/services/new/incoming-webhook"
-      method :post
-
-      body "payload" do
-        data_type "Payload"
-      end
-    end
-  end
-
-  complex_type "Payload" do
-    required :text 
-    property :text
-    property :channel
-    property :username
-    property :icon_url
-    property :icon_emoji
-  end
-
-end
-

data/examples/post_slack_message.rb

@@ -1,8 +0,0 @@
-require 'diesel'
-require 'logger'
-
-Slack = Diesel.load_api 'apis/slack'
-api = Slack.new
-api.logger = Logger.new STDOUT
-api.api_token = YOUR_API_TOKEN
-puts api.send_message(payload: {text: 'testing', channel: '#developers', username: 'calvin'})