reed_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df6a35144f12a4c3dfb4c05c91efd88060400e90acb5b83e90676d9ce5543f51
+  data.tar.gz: b5d263d59333c4751061fc2bbf03adbbcdd8ee77f768508513271189db0f38e0
+SHA512:
+  metadata.gz: 72e0bbdfe9a6bf7a1eb0a4f2192c5252862c8a2c5b99fd707d496b7c5d9bada307bea04a4c4b7c6a3f3a634661d76a130ad9bc31cfb781de5c90251a22f0aa3a
+  data.tar.gz: d44dc695040401db6389ff265d11b9cb33b6982cf57fca32ba42da4ab23f05e374ae67dcc018d4c661164dc8e6e50e5bb5613bc1b9d77d8d7ee315494dd0bf66

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,114 @@
+# reed_sdk
+
+ReedSdk - the Ruby gem for the The One Api Client
+
+This is a sample client for the the-one-api service.
+This client implements endpoints related to movie and quotes.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build reed_sdk.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./reed_sdk-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./reed_sdk-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'reed_sdk', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'reed_sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'reed_sdk'
+
+# Setup authorization
+ReedSdk.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+end
+
+api_instance = ReedSdk::TheOneApiApi.new
+id = 'id_example' # String | Movie ID
+
+begin
+  #Retrieve a movie by a specific ID
+  result = api_instance.retrieve_movie(id)
+  p result
+rescue ReedSdk::ApiError => e
+  puts "Exception when calling TheOneApiApi->retrieve_movie: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://the-one-api.dev/v2*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ReedSdk::TheOneApiApi* | [**retrieve_movie**](docs/TheOneApiApi.md#retrieve_movie) | **GET** /movie/{id} | Retrieve a movie by a specific ID
+*ReedSdk::TheOneApiApi* | [**retrieve_movie_quotes**](docs/TheOneApiApi.md#retrieve_movie_quotes) | **GET** /movie/{id}/quote | Retrieve a specific movies quotes.
+*ReedSdk::TheOneApiApi* | [**retrieve_movies**](docs/TheOneApiApi.md#retrieve_movies) | **GET** /movie | Retrieve all movies
+*ReedSdk::TheOneApiApi* | [**retrieve_quote**](docs/TheOneApiApi.md#retrieve_quote) | **GET** /quote/{id} | Retrieve a specific movie quote
+*ReedSdk::TheOneApiApi* | [**retrieve_quotes**](docs/TheOneApiApi.md#retrieve_quotes) | **GET** /quote | Retrieve all movie quotes
+
+
+## Documentation for Models
+
+ - [ReedSdk::Movie](docs/Movie.md)
+ - [ReedSdk::MovieAllOf](docs/MovieAllOf.md)
+ - [ReedSdk::Movies](docs/Movies.md)
+ - [ReedSdk::MoviesAllOf](docs/MoviesAllOf.md)
+ - [ReedSdk::Paged](docs/Paged.md)
+ - [ReedSdk::Quote](docs/Quote.md)
+ - [ReedSdk::QuoteAllOf](docs/QuoteAllOf.md)
+ - [ReedSdk::Quotes](docs/Quotes.md)
+ - [ReedSdk::QuotesAllOf](docs/QuotesAllOf.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### bearerAuth
+
+- **Type**: Bearer authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/build.sh

@@ -0,0 +1 @@
+npx @openapitools/openapi-generator-cli generate -i definition/swagger.yaml -g ruby -o ./ --package-name reed_sdk --global-property=apiDocs=true -c config.yaml

data/bin/setup.sh

@@ -0,0 +1 @@
+wget -O ./bin/swagger-codegen.jar https://oss.sonatype.org/content/repositories/releases/io/swagger/swagger-codegen-cli/2.2.1/swagger-codegen-cli-2.2.1.jar

data/config.yaml

@@ -0,0 +1 @@
+gemName: reed_sdk

data/definition/swagger.yaml

@@ -0,0 +1,241 @@
+openapi: 3.0.3
+info:
+  title: The One Api Client
+  description: >-
+    This is a sample client for the the-one-api service.
+    
+    This client implements endpoints related to movie and quotes.
+  version: 1.0.0
+servers:
+  - url: https://the-one-api.dev/v2/
+security:
+  - bearerAuth: []
+paths:
+  /movie:
+    get:
+      tags: [TheOneApi]
+      summary: Retrieve all movies
+      description: Retrieves all movies in the database.
+      operationId: retrieveMovies
+      parameters:
+        - name: limit
+          in: query
+          required: false
+          schema:
+            type: integer
+        - name: page
+          in: query
+          required: false
+          schema:
+            type: integer
+        - name: offset
+          in: query
+          required: false
+          schema:
+            type: integer
+        - name: sort
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Movies'
+  /movie/{id}:
+    get:
+      tags: [TheOneApi]
+      summary: Retrieve a movie by a specific ID
+      description: Retrieves a specific movie by ID or returns an empty response.
+      operationId: retrieveMovie
+      parameters:
+        - name: id
+          in: path
+          description: Movie ID
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                $ref: '#/components/schemas/Movie'
+  /movie/{id}/quote:
+    get:
+      tags: [TheOneApi]
+      summary: Retrieve a specific movies quotes.
+      description: Retrieve a sepcific movie's quotes or return an empty response.
+      operationId: retrieveMovieQuotes
+      parameters:
+        - name: id
+          in: path
+          description: Movie ID
+          required: true
+          schema:
+            type: string
+        - name: limit
+          in: query
+          required: false
+          schema:
+            type: integer
+        - name: page
+          in: query
+          required: false
+          schema:
+            type: integer
+        - name: offset
+          in: query
+          required: false
+          schema:
+            type: integer
+        - name: sort
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                $ref: '#/components/schemas/Quotes'
+  /quote:
+    get:
+      tags: [TheOneApi]
+      summary: Retrieve all movie quotes
+      description: Retrieves a list of all movie quotes
+      operationId: retrieveQuotes
+      parameters:
+        - name: limit
+          in: query
+          required: false
+          schema:
+            type: integer
+        - name: page
+          in: query
+          required: false
+          schema:
+            type: integer
+        - name: offset
+          in: query
+          required: false
+          schema:
+            type: integer
+        - name: sort
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                $ref: '#/components/schemas/Quotes'
+  /quote/{id}:
+    get:
+      tags: [TheOneApi]
+      summary: Retrieve a specific movie quote
+      description: Retrieves a specific quote by ID or returns an empty response.
+      operationId: retrieveQuote
+      parameters:
+        - name: id
+          in: path
+          description: Quote ID
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                $ref: '#/components/schemas/Quote'
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+  schemas:
+    Paged:
+      type: object
+      properties:
+        total:
+          type: integer
+        limit:
+          type: integer
+        offset:
+          type: integer
+        page:
+          type: integer
+        pages:
+          type: integer
+    Movies:
+      allOf:
+        - $ref: '#/components/schemas/Paged'
+        - type: object
+          properties:
+            docs:
+              type: array
+              items:
+                $ref: '#/components/schemas/Movie'
+    Movie:
+      allOf:
+        - $ref: '#/components/schemas/Paged'
+        - type: object
+          properties:
+            id:
+              type: string
+            name:
+              type: string
+            runtimeInMinutes:
+              type: integer
+              format: int32
+              example: 120
+            boxOfficeRevenueInMillions:
+              type: integer
+              format: int32
+            academyAwardNominations:
+              type: integer
+              format: int32
+            academyAwardWins:
+              type: integer
+              format: int32
+            rottenTomatoesScore:
+              type: number
+    Quotes:
+      allOf:
+        - $ref: '#/components/schemas/Paged'
+        - type: object
+          properties:
+            docs:
+              type: array
+              items:
+                $ref: '#/components/schemas/Quote'
+    Quote:
+      allOf:
+        - $ref: '#/components/schemas/Paged'
+        - type: object
+          properties:
+            _id:
+              type: string
+            dialog:
+              type: string
+            movie:
+              type: string
+            character:
+              type: string
+            id:
+              type: string

data/docs/Movie.md

@@ -0,0 +1,40 @@
+# ReedSdk::Movie
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+| **page** | **Integer** |  | [optional] |
+| **pages** | **Integer** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **runtime_in_minutes** | **Integer** |  | [optional] |
+| **box_office_revenue_in_millions** | **Integer** |  | [optional] |
+| **academy_award_nominations** | **Integer** |  | [optional] |
+| **academy_award_wins** | **Integer** |  | [optional] |
+| **rotten_tomatoes_score** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'reed_sdk'
+
+instance = ReedSdk::Movie.new(
+  total: null,
+  limit: null,
+  offset: null,
+  page: null,
+  pages: null,
+  id: null,
+  name: null,
+  runtime_in_minutes: 120,
+  box_office_revenue_in_millions: null,
+  academy_award_nominations: null,
+  academy_award_wins: null,
+  rotten_tomatoes_score: null
+)
+```
+

data/docs/MovieAllOf.md

@@ -0,0 +1,30 @@
+# ReedSdk::MovieAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **runtime_in_minutes** | **Integer** |  | [optional] |
+| **box_office_revenue_in_millions** | **Integer** |  | [optional] |
+| **academy_award_nominations** | **Integer** |  | [optional] |
+| **academy_award_wins** | **Integer** |  | [optional] |
+| **rotten_tomatoes_score** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'reed_sdk'
+
+instance = ReedSdk::MovieAllOf.new(
+  id: null,
+  name: null,
+  runtime_in_minutes: 120,
+  box_office_revenue_in_millions: null,
+  academy_award_nominations: null,
+  academy_award_wins: null,
+  rotten_tomatoes_score: null
+)
+```
+

data/docs/Movies.md

@@ -0,0 +1,28 @@
+# ReedSdk::Movies
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+| **page** | **Integer** |  | [optional] |
+| **pages** | **Integer** |  | [optional] |
+| **docs** | [**Array<Movie>**](Movie.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'reed_sdk'
+
+instance = ReedSdk::Movies.new(
+  total: null,
+  limit: null,
+  offset: null,
+  page: null,
+  pages: null,
+  docs: null
+)
+```
+

data/docs/MoviesAllOf.md

@@ -0,0 +1,18 @@
+# ReedSdk::MoviesAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **docs** | [**Array<Movie>**](Movie.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'reed_sdk'
+
+instance = ReedSdk::MoviesAllOf.new(
+  docs: null
+)
+```
+

data/docs/Paged.md

@@ -0,0 +1,26 @@
+# ReedSdk::Paged
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+| **page** | **Integer** |  | [optional] |
+| **pages** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'reed_sdk'
+
+instance = ReedSdk::Paged.new(
+  total: null,
+  limit: null,
+  offset: null,
+  page: null,
+  pages: null
+)
+```
+

data/docs/Quote.md

@@ -0,0 +1,36 @@
+# ReedSdk::Quote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+| **page** | **Integer** |  | [optional] |
+| **pages** | **Integer** |  | [optional] |
+| **_id** | **String** |  | [optional] |
+| **dialog** | **String** |  | [optional] |
+| **movie** | **String** |  | [optional] |
+| **character** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'reed_sdk'
+
+instance = ReedSdk::Quote.new(
+  total: null,
+  limit: null,
+  offset: null,
+  page: null,
+  pages: null,
+  _id: null,
+  dialog: null,
+  movie: null,
+  character: null,
+  id: null
+)
+```
+

data/docs/QuoteAllOf.md

@@ -0,0 +1,26 @@
+# ReedSdk::QuoteAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  | [optional] |
+| **dialog** | **String** |  | [optional] |
+| **movie** | **String** |  | [optional] |
+| **character** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'reed_sdk'
+
+instance = ReedSdk::QuoteAllOf.new(
+  _id: null,
+  dialog: null,
+  movie: null,
+  character: null,
+  id: null
+)
+```
+

data/docs/Quotes.md

@@ -0,0 +1,28 @@
+# ReedSdk::Quotes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+| **page** | **Integer** |  | [optional] |
+| **pages** | **Integer** |  | [optional] |
+| **docs** | [**Array<Quote>**](Quote.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'reed_sdk'
+
+instance = ReedSdk::Quotes.new(
+  total: null,
+  limit: null,
+  offset: null,
+  page: null,
+  pages: null,
+  docs: null
+)
+```
+

data/docs/QuotesAllOf.md

@@ -0,0 +1,18 @@
+# ReedSdk::QuotesAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **docs** | [**Array<Quote>**](Quote.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'reed_sdk'
+
+instance = ReedSdk::QuotesAllOf.new(
+  docs: null
+)
+```
+