fictium 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 421d8ab0b9aa1bb7982edf6cf39a156179f2ec1f02c72b7b79bb96e8cfc33f05
-  data.tar.gz: 936e8e3849fe1ef47f5c4af212cb7b3985def25284c1f755188f0b42a545b4e7
+  metadata.gz: 3030636739bbc598cfa705f9708eb907a8c5bbe8d8937758ff89ef1550437d5a
+  data.tar.gz: 9a835767818e69d27fec2eb97ba86a222186226c59a32416d06deea61db36714
 SHA512:
-  metadata.gz: 0cc22b7038a90471b18054314feaa182d558fcf29c6f79926ec9c1ccdce4267b69e1fda8b416b1605abbf3b0395c7210c1a17e11c29939fb86ef68e7a491f371
-  data.tar.gz: 29044b70d6d0ad7ad05f08eaa565979d43f0827dc554ab81c3c87926bede9b3ecd4b06c171e0071970c76017a5d0b7bfc0b43ca31a10b9b231b3d289614df54a
+  metadata.gz: 83902c23aae9e3851f5051127c563f47852c09b0a344ec7b7fd839c24ffa11bcc1a860d0fab60e5e9a21a47aa8a8a2d1c1e80ab5da97df66da3f8eeb47166d55
+  data.tar.gz: 893041779f809d490a110b2f6106c839f59633a01413673b2e4ebfa8ec112f15a726f58e665110cf2c7938825bf45960db09c82d6e3ff30f58337746d4346351

data/.travis.yml

@@ -1,4 +1,7 @@
 ---
+env:
+  global:
+    - CC_TEST_REPORTER_ID=ABC532a889d0bb9f79e63dd72a6c99b669b5349b81a7defb42cdde4f0dc5684e874
 sudo: false
 language: ruby
 cache: bundler
@@ -10,4 +13,10 @@ rvm:
 before_install:
  - gem install bundler -v 2.0.2
  - bundle install
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 script: bundle exec rake travis:analyze
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -17,6 +17,15 @@
 
 ## LOG
 
+### 0.3.0 (2019-11-12)
+
+New exporter: Postman.
+
+#### Changes
+
+- Allow to export the documentation as a Postman collection. (Even with examples)
+- Added code climate's integration for test coverage.
+
 ### 0.2.0 (2019-11-12)
 
 New exporter: API Blueprint.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fictium (0.2.0)
+    fictium (0.3.0)
       activesupport (>= 5.3, < 6.2)
       json-schema (~> 2.8)
       verbs (~> 2.1.4)

data/README.md

@@ -13,6 +13,7 @@ The current Gem version allows to export into the following formats:
 |---          |---         |---    |
 | [OpenApi 3.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) | `Fictium::OpenApi::V3Exporter`    | The default exporter for the current Gem version. It doesn't include 100% of the OpenAPI specification, but it works for the most common use cases. It's the format [Swagger](https://swagger.io/) uses for documentation. |
 | [API Blueprint](https://apiblueprint.org/documentation/specification.html) | `Fictium::ApiBlueprintExporter`| Used by [Apiary](https://apiary.io/). A superset of Markdown with special keywords and controls. |
+| [Postman Collection](https://schema.getpostman.com/json/collection/v2.1.0/docs/index.html) | `Fictium::Postman::V2Exporter` | Export your test as a [Postman](https://www.getpostman.com/) collection for easy creation of mock APIs and quick debugging. |
 
 Future versions may provide:
 

data/lib/fictium/configurations/configuration.rb

@@ -12,7 +12,7 @@ module Fictium
     ].freeze
     private_constant :VOWEL
 
-    attr_reader :info, :api_blueprint
+    attr_reader :info, :api_blueprint, :postman
     attr_accessor :exporters, :summary_format, :default_action_descriptors,
                   :unknown_action_descriptor, :default_subject, :fixture_path,
                   :export_path, :default_response_content_type, :pretty_print,
@@ -21,6 +21,7 @@ module Fictium
     def initialize
       @info = Fictium::Configuration::Info.new
       @api_blueprint = Fictium::Configuration::ApiBlueprint.new
+      @postman = Fictium::Configuration::Postman.new
       @exporters = [Fictium::OpenApi::V3Exporter.new]
 
       @summary_format = method(:default_summary_format)

data/lib/fictium/configurations/postman.rb

@@ -0,0 +1,29 @@
+module Fictium
+  class Configuration
+    class Postman
+      attr_accessor :id, :api_url, :default_status_names, :unknown_status_name, :example_formatter
+
+      def initialize
+        @api_url = '{{API_URL}}'
+        @example_formatter = method(:format_example)
+        @default_status_names = {}
+        @unknown_status_name = method(:format_unknown_status_name)
+      end
+
+      private
+
+      def format_example(status, example)
+        "[#{status}] #{status_name_for(status, example)}"
+      end
+
+      def status_name_for(status, example)
+        method = default_status_names[status] || unknown_status_name
+        method.call(status, example)
+      end
+
+      def format_unknown_status_name(_status, example)
+        example.summary
+      end
+    end
+  end
+end

data/lib/fictium/evaluators/postman_evaluator.rb

@@ -0,0 +1,59 @@
+module Fictium
+  class PostmanEvaluator
+    attr_reader :subject
+
+    delegate :postman, to: :subject
+
+    def initialize(subject)
+      @subject = subject
+    end
+
+    def evaluate(&block)
+      instance_eval(&block)
+    end
+
+    private
+
+    def pre_request(script:, disabled: false)
+      postman.event ||= []
+      postman.event << {
+        listen: :pre_request,
+        disabled: disabled,
+        script: {
+          exec: script.to_s.lines
+        }
+      }
+    end
+
+    def test(script:, disabled: false)
+      postman.event ||= []
+      postman.event << {
+        listen: :test,
+        disabled: disabled,
+        script: {
+          exec: script.to_s.lines
+        }
+      }
+    end
+
+    def variable(name:, value: '', type: :string, disabled: false)
+      postman.variable ||= []
+      postman.variable << { name: name, value: value, type: type, disabled: disabled }
+    end
+
+    def auth(**kwargs)
+      raise NoMethodError unless resource? || document?
+
+      key = kwargs.keys.first
+      postman.auth = { type: key, key => kwargs[key] }
+    end
+
+    def resource?
+      subject.is_a?(Fictium::Resource)
+    end
+
+    def document?
+      subject.is_a?(Fictium::Document)
+    end
+  end
+end