open_api-loader 0.0.1

data/spec/fixtures/oas3/source.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","servers":[{"url":"{scheme}://developer.uspto.gov/ds-api","variables":{"scheme":{"description":"The Data Set API is accessible via https and http","enum":["https","http"],"default":"https"}}}],"info":{"description":"The Data Set API (DSAPI) allows the public users to discover and search USPTO exported data sets. This is a generic API that allows USPTO users to make any CSV based data files searchable through API. With the help of GET call, it returns the list of data fields that are searchable. With the help of POST call, data can be fetched based on the filters on the field names. Please note that POST call is used to search the actual data. The reason for the POST call is that it allows users to specify any complex search criteria without worry about the GET size limitations as well as encoding of the input parameters.","version":"1.0.0","title":"USPTO Data Set API","contact":{"name":"Open Data Portal","url":"https://developer.uspto.gov","email":"developer@uspto.gov"}},"tags":[{"name":"metadata","description":"Find out about the data sets"},{"name":"search","description":"Search a data set"}],"paths":{"/":{"get":{"tags":["metadata"],"operationId":"list-data-sets","summary":"List available data sets","responses":{"200":{"description":"Returns a list of data sets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataSetList"},"example":{"total":2,"apis":[{"apiKey":"oa_citations","apiVersionNumber":"v1","apiUrl":"https://developer.uspto.gov/ds-api/oa_citations/v1/fields","apiDocumentationUrl":"https://developer.uspto.gov/ds-api-docs/index.html?url=https://developer.uspto.gov/ds-api/swagger/docs/oa_citations.json"},{"apiKey":"cancer_moonshot","apiVersionNumber":"v1","apiUrl":"https://developer.uspto.gov/ds-api/cancer_moonshot/v1/fields","apiDocumentationUrl":"https://developer.uspto.gov/ds-api-docs/index.html?url=https://developer.uspto.gov/ds-api/swagger/docs/cancer_moonshot.json"}]}}}}}}},"/{dataset}/{version}/fields":{"parameters":[{"name":"dataset","in":"path","description":"Name of the dataset. In this case, the default value is oa_citations","required":true,"schema":{"type":"string","default":"oa_citations"}},{"name":"version","in":"path","description":"Version of the dataset.","required":true,"schema":{"type":"string","default":"v1"}}],"get":{"tags":["metadata"],"summary":"Provides the general information about the API and the list of fields that can be used to query the dataset.","description":"This GET API returns the list of all the searchable field names that are in the oa_citations. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the syntax options shown below.","operationId":"list-searchable-fields","responses":{"200":{"description":"The dataset api for the given version is found and it is accessible to consume.","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"The combination of dataset name and version is not found in the system or it is not published yet to be consumed by public.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/{dataset}/{version}/records":{"parameters":[{"name":"version","in":"path","description":"Version of the dataset.","required":true,"schema":{"type":"string","default":"v1"}},{"name":"dataset","in":"path","description":"Name of the dataset. In this case, the default value is oa_citations","required":true,"schema":{"type":"string","default":"oa_citations"}}],"post":{"tags":["search"],"summary":"Provides search capability for the data set with the given search criteria.","description":"This API is based on Solr/Lucense Search. The data is indexed using SOLR. This GET API returns the list of all the searchable field names that are in the Solr Index. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the Solr/Lucene Syntax. Please refer https://lucene.apache.org/core/3_6_2/queryparsersyntax.html#Overview for the query syntax. List of field names that are searchable can be determined using above GET api.","operationId":"perform-search","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}}}}},"404":{"description":"No matching record found for the given criteria."}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"criteria":{"description":"Uses Lucene Query Syntax in the format of propertyName:value, propertyName:[num1 TO num2] and date range format: propertyName:[yyyyMMdd TO yyyyMMdd]. In the response please see the 'docs' element which has the list of record objects. Each record structure would consist of all the fields and their corresponding values.","type":"string","default":"*:*"},"start":{"description":"Starting record number. Default value is 0.","type":"integer","default":0},"rows":{"description":"Specify number of rows to be returned. If you run the search with default values, in the response you will see 'numFound' attribute which will tell the number of records available in the dataset.","type":"integer","default":100}},"required":["criteria"]}}}}}}},"components":{"schemas":{"dataSetList":{"type":"object","properties":{"total":{"type":"integer"},"apis":{"type":"array","items":{"type":"object","properties":{"apiKey":{"type":"string","description":"To be used as a dataset parameter value"},"apiVersionNumber":{"type":"string","description":"To be used as a version parameter value"},"apiUrl":{"type":"string","format":"uriref","description":"The URL describing the dataset's fields"},"apiDocumentationUrl":{"type":"string","format":"uriref","description":"A URL to the API console for each API"}}}}}}}}}

data/spec/fixtures/oas3/source.yaml

@@ -0,0 +1,217 @@
+#
+# The OAS3 specification downloaded from
+# https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/uspto.yaml
+#
+# The source.json contain exactly the same data in JSON format
+#
+---
+openapi: 3.0.0
+servers:
+  - url: '{scheme}://developer.uspto.gov/ds-api'
+    variables:
+      scheme:
+        description: 'The Data Set API is accessible via https and http'
+        enum:
+          - 'https'
+          - 'http'
+        default: 'https'
+info:
+  description: >-
+    The Data Set API (DSAPI) allows the public users to discover and search
+    USPTO exported data sets. This is a generic API that allows USPTO users to
+    make any CSV based data files searchable through API. With the help of GET
+    call, it returns the list of data fields that are searchable. With the help
+    of POST call, data can be fetched based on the filters on the field names.
+    Please note that POST call is used to search the actual data. The reason for
+    the POST call is that it allows users to specify any complex search criteria
+    without worry about the GET size limitations as well as encoding of the
+    input parameters.
+  version: 1.0.0
+  title: USPTO Data Set API
+  contact:
+    name: Open Data Portal
+    url: 'https://developer.uspto.gov'
+    email: developer@uspto.gov
+tags:
+  - name: metadata
+    description: Find out about the data sets
+  - name: search
+    description: Search a data set
+paths:
+  /:
+    get:
+      tags:
+        - metadata
+      operationId: list-data-sets
+      summary: List available data sets
+      responses:
+        200:
+          description: Returns a list of data sets
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataSetList'
+              example:
+                {
+                  "total": 2,
+                  "apis": [
+                    {
+                      "apiKey": "oa_citations",
+                      "apiVersionNumber": "v1",
+                      "apiUrl": "https://developer.uspto.gov/ds-api/oa_citations/v1/fields",
+                      "apiDocumentationUrl": "https://developer.uspto.gov/ds-api-docs/index.html?url=https://developer.uspto.gov/ds-api/swagger/docs/oa_citations.json"
+                    },
+                    {
+                      "apiKey": "cancer_moonshot",
+                      "apiVersionNumber": "v1",
+                      "apiUrl": "https://developer.uspto.gov/ds-api/cancer_moonshot/v1/fields",
+                      "apiDocumentationUrl": "https://developer.uspto.gov/ds-api-docs/index.html?url=https://developer.uspto.gov/ds-api/swagger/docs/cancer_moonshot.json"
+                    }
+                  ]
+                }
+  /{dataset}/{version}/fields:
+    parameters:
+      - name: dataset
+        in: path
+        description: 'Name of the dataset. In this case, the default value is oa_citations'
+        required: true
+        schema:
+          type: string
+          default: oa_citations
+      - name: version
+        in: path
+        description: Version of the dataset.
+        required: true
+        schema:
+          type: string
+          default: v1
+    get:
+      tags:
+        - metadata
+      summary: >-
+        Provides the general information about the API and the list of fields
+        that can be used to query the dataset.
+      description: >-
+        This GET API returns the list of all the searchable field names that are
+        in the oa_citations. Please see the 'fields' attribute which returns an
+        array of field names. Each field or a combination of fields can be
+        searched using the syntax options shown below.
+      operationId: list-searchable-fields
+      responses:
+        200:
+          description: >-
+            The dataset api for the given version is found and it is accessible
+            to consume.
+          content:
+            application/json:
+              schema:
+                type: string
+        404:
+          description: >-
+            The combination of dataset name and version is not found in the
+            system or it is not published yet to be consumed by public.
+          content:
+            application/json:
+              schema:
+                type: string
+  /{dataset}/{version}/records:
+    parameters:
+      - name: version
+        in: path
+        description: Version of the dataset.
+        required: true
+        schema:
+          type: string
+          default: v1
+      - name: dataset
+        in: path
+        description: 'Name of the dataset. In this case, the default value is oa_citations'
+        required: true
+        schema:
+          type: string
+          default: oa_citations
+    post:
+      tags:
+        - search
+      summary: >-
+        Provides search capability for the data set with the given search
+        criteria.
+      description: >-
+        This API is based on Solr/Lucense Search. The data is indexed using
+        SOLR. This GET API returns the list of all the searchable field names
+        that are in the Solr Index. Please see the 'fields' attribute which
+        returns an array of field names. Each field or a combination of fields
+        can be searched using the Solr/Lucene Syntax. Please refer
+        https://lucene.apache.org/core/3_6_2/queryparsersyntax.html#Overview for
+        the query syntax. List of field names that are searchable can be
+        determined using above GET api.
+      operationId: perform-search
+      responses:
+        200:
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  additionalProperties:
+                    type: object
+        404:
+          description: No matching record found for the given criteria.
+      requestBody:
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              type: object
+              properties:
+                criteria:
+                  description: >-
+                    Uses Lucene Query Syntax in the format of
+                    propertyName:value, propertyName:[num1 TO num2] and date
+                    range format: propertyName:[yyyyMMdd TO yyyyMMdd]. In the
+                    response please see the 'docs' element which has the list of
+                    record objects. Each record structure would consist of all
+                    the fields and their corresponding values.
+                  type: string
+                  default: '*:*'
+                start:
+                  description: Starting record number. Default value is 0.
+                  type: integer
+                  default: 0
+                rows:
+                  description: >-
+                    Specify number of rows to be returned. If you run the search
+                    with default values, in the response you will see 'numFound'
+                    attribute which will tell the number of records available in
+                    the dataset.
+                  type: integer
+                  default: 100
+              required:
+                - criteria
+components:
+  schemas:
+    dataSetList:
+      type: object
+      properties:
+        total:
+          type: integer
+        apis:
+          type: array
+          items:
+            type: object
+            properties:
+              apiKey:
+                type: string
+                description: To be used as a dataset parameter value
+              apiVersionNumber:
+                type: string
+                description: To be used as a version parameter value
+              apiUrl:
+                type: string
+                format: uriref
+                description: "The URL describing the dataset's fields"
+              apiDocumentationUrl:
+                type: string
+                format: uriref
+                description: A URL to the API console for each API

data/spec/loader_spec.rb

@@ -0,0 +1,53 @@
+RSpec.describe OpenAPI::Loader do
+  subject { described_class.call(source, **options) }
+
+  let(:options) { {} }
+
+  context "with OAS 2" do
+    context "in YAML" do
+      let(:source) { "spec/fixtures/oas2/source.yaml" }
+      let(:target) { yaml_fixture_file "oas2/denormalized.yaml" }
+
+      it { is_expected.to eq target }
+    end
+
+    context "in JSON" do
+      let(:source) { "spec/fixtures/oas2/source.json" }
+      let(:target) { yaml_fixture_file "oas2/denormalized.yaml" }
+
+      it { is_expected.to eq target }
+    end
+
+    context "with option denormalize: false" do
+      let(:source)  { "spec/fixtures/oas2/source.yaml" }
+      let(:target)  { yaml_fixture_file "oas2/translated.yaml" }
+      let(:options) { { denormalize: false } }
+
+      it { is_expected.to eq target }
+    end
+  end
+
+  context "with OAS 3" do
+    context "in YAML" do
+      let(:source) { "spec/fixtures/oas3/source.yaml" }
+      let(:target) { yaml_fixture_file "oas3/denormalized.yaml" }
+
+      it { is_expected.to eq target }
+    end
+
+    context "in JSON" do
+      let(:source) { "spec/fixtures/oas3/source.json" }
+      let(:target) { yaml_fixture_file "oas3/denormalized.yaml" }
+
+      it { is_expected.to eq target }
+    end
+
+    context "with option denormalize: false" do
+      let(:source)  { "spec/fixtures/oas3/source.yaml" }
+      let(:target)  { yaml_fixture_file "oas3/collected.yaml" }
+      let(:options) { { denormalize: false } }
+
+      it { is_expected.to eq target }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "bundler/setup"
+require "pry"
+require "webmock/rspec"
+require "open_api/loader"
+require "rspec/its"
+
+require_relative "support/fixture_helpers"
+require_relative "support/path_helpers"
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = ".rspec_status"
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+
+  config.order = :random
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/fixture_helpers.rb

@@ -0,0 +1,18 @@
+require "yaml"
+require "json"
+
+def fixture_file_path(filename)
+  File.expand_path "spec/fixtures/#{filename}"
+end
+
+def read_fixture_file(filename)
+  File.read fixture_file_path(filename)
+end
+
+def yaml_fixture_file(filename, **_params)
+  YAML.load read_fixture_file(filename)
+end
+
+def json_fixture_file(filename)
+  JSON.parse read_fixture_file(filename)
+end

data/spec/support/path_helpers.rb

@@ -0,0 +1,27 @@
+def local_path(content)
+  file = Tempfile.create ""
+  File.write file, content
+  file.path
+end
+
+def remote_path(content)
+  path = "https://www.example.com/source"
+  stub_request(:get, path).to_return(body: content)
+  path
+end
+
+def yaml_local_path(data)
+  local_path YAML.dump(data)
+end
+
+def yaml_remote_path(data)
+  remote_path YAML.dump(data)
+end
+
+def json_local_path(data)
+  local_path JSON.dump(data)
+end
+
+def json_remote_path(data)
+  remote_path JSON.dump(data)
+end

data/spec/unit/collector_spec.rb

@@ -0,0 +1,31 @@
+RSpec.describe OpenAPI::Loader::Collector, ".call" do
+  subject { described_class.call(source) }
+
+  context "OAS 2" do
+    let(:target) { yaml_fixture_file "oas2/collected.yaml" }
+
+    context "from local yaml" do
+      let(:source) { "spec/fixtures/oas2/source.yaml" }
+      it { is_expected.to eq target }
+    end
+
+    context "from local json" do
+      let(:source) { "spec/fixtures/oas2/source.json" }
+      it { is_expected.to eq target }
+    end
+  end
+
+  context "OAS 3" do
+    let(:target) { yaml_fixture_file "oas3/collected.yaml" }
+
+    context "from local yaml" do
+      let(:source) { "spec/fixtures/oas3/source.yaml" }
+      it { is_expected.to eq target }
+    end
+
+    context "from local json" do
+      let(:source) { "spec/fixtures/oas3/source.json" }
+      it { is_expected.to eq target }
+    end
+  end
+end

data/spec/unit/denormalizer_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe OpenAPI::Loader::Denormalizer, ".call" do
+  subject { described_class.call(source) }
+
+  context "OAS 2" do
+    let(:source) { yaml_fixture_file "oas2/translated.yaml" }
+    let(:target) { yaml_fixture_file "oas2/denormalized.yaml" }
+
+    it { is_expected.to eq target }
+  end
+
+  context "OAS 3" do
+    let(:source) { yaml_fixture_file "oas3/collected.yaml" }
+    let(:target) { yaml_fixture_file "oas3/denormalized.yaml" }
+
+    it { is_expected.to eq target }
+  end
+end

data/spec/unit/reader_spec.rb

@@ -0,0 +1,53 @@
+RSpec.describe OpenAPI::Loader::Reader, ".call" do
+  subject { described_class.call(source) }
+
+  context "from local yaml" do
+    let(:source) { "spec/fixtures/oas2/source.yaml" }
+    let(:target) { yaml_fixture_file "oas2/loaded.yaml" }
+
+    it { is_expected.to eq target }
+  end
+
+  context "from local json" do
+    let(:source) { "spec/fixtures/oas2/source.json" }
+    let(:target) { yaml_fixture_file "oas2/loaded.yaml" }
+
+    it { is_expected.to eq target }
+  end
+
+  context "from another existing local" do
+    let(:source) { local_path target }
+    let(:target) { "foo" }
+
+    it { is_expected.to eq target }
+  end
+
+  context "from absent local" do
+    let(:source) { "foo" }
+
+    it "raises StandardError" do
+      expect { subject }.to raise_error(StandardError)
+    end
+  end
+
+  context "from remote yaml" do
+    let(:source) { yaml_remote_path(target) }
+    let(:target) { { "foo" => "bar" } }
+
+    it { is_expected.to eq target }
+  end
+
+  context "from remote json" do
+    let(:source) { json_remote_path(target) }
+    let(:target) { { "foo" => "bar" } }
+
+    it { is_expected.to eq target }
+  end
+
+  context "from another remote" do
+    let(:source) { remote_path(target) }
+    let(:target) { "foo" }
+
+    it { is_expected.to eq target }
+  end
+end

data/spec/unit/ref_spec.rb

@@ -0,0 +1,107 @@
+RSpec.describe OpenAPI::Loader::Ref do
+  describe ".new" do
+    subject { described_class.new(source) }
+
+    context "with a pointer to the external subpath" do
+      let(:source) { "https://example.com#/foo/ /e%5Ef/a~10b/m~01n" }
+
+      it { is_expected.to eq source }
+      its(:uri)  { is_expected.to eq URI("https://example.com") }
+      its(:path) { is_expected.to eq ["foo", " ", "e^f", "a/0b", "m~1n"] }
+    end
+
+    context "with an explicit pointer to the current root" do
+      let(:source) { "#" }
+
+      it { is_expected.to eq source }
+      its(:uri)  { is_expected.to be_nil }
+      its(:path) { is_expected.to eq [] }
+    end
+
+    context "with an implicit pointer to the current root" do
+      let(:source) { "" }
+
+      it { is_expected.to eq "#" }
+      its(:uri)  { is_expected.to be_nil }
+      its(:path) { is_expected.to eq [] }
+    end
+
+    context "with a local pointer" do
+      let(:source) { "#/foo/ /e%5Ef/a~10b/m~01n" }
+
+      it { is_expected.to eq source }
+      its(:uri)  { is_expected.to be_nil }
+      its(:path) { is_expected.to eq ["foo", " ", "e^f", "a/0b", "m~1n"] }
+    end
+
+    context "with an explicit pointer to the external root" do
+      let(:source) { "https://example.com/#" }
+
+      it { is_expected.to eq source }
+      its(:uri)  { is_expected.to eq URI("https://example.com/") }
+      its(:path) { is_expected.to eq [] }
+    end
+
+    context "without an implicit pointer to the external root" do
+      let(:source) { "https://example.com/foo" }
+
+      it { is_expected.to eq "https://example.com/foo#" }
+      its(:uri)  { is_expected.to eq URI("https://example.com/foo") }
+      its(:path) { is_expected.to eq [] }
+    end
+
+    context "with an external pointer" do
+      let(:source) { "https://example.com/foo#/foo/ /e%5Ef/a~10b/m~01n" }
+
+      it { is_expected.to eq source }
+      its(:uri)  { is_expected.to eq URI("https://example.com/foo") }
+      its(:path) { is_expected.to eq ["foo", " ", "e^f", "a/0b", "m~1n"] }
+    end
+
+    context "with several #" do
+      let(:source) { "#/foo#/ /e%5Ef/a~10b/m~01n" }
+
+      it "raises ArgumentError" do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "with a # succeeded not by a slash" do
+      let(:source) { "# /foo/ /e%5Ef/a~10b/m~01n" }
+
+      it "raises ArgumentError" do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe ".[]" do
+    subject { described_class[*path] }
+
+    let(:path) { %w[foo~/bar 0 baz/~qux] }
+
+    it { is_expected.to eq "#/foo~0~1bar/0/baz~1~0qux" }
+  end
+
+  describe "#fetch_from" do
+    subject { ref.fetch_from(data) }
+
+    let(:ref)  { described_class.new "#/foo/0/bar" }
+
+    context "when value is present" do
+      let(:data) { { "foo" => [{ "bar" => :BAZ }] } }
+
+      it "finds the value" do
+        expect(subject).to eq :BAZ
+      end
+    end
+
+    context "when value is absent" do
+      let(:data) { { "foo" => { "bar" => :BAZ } } }
+
+      it "raises key error" do
+        expect { subject }.to raise_error(KeyError, %r{'#/foo/0'})
+      end
+    end
+  end
+end