refsheet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 756719eeab5fa7b52b7be6cd2411ff14834159190faeb1f6a0bcffc4ea9000ca
+  data.tar.gz: ab7f5dff7bea894fe47b73b3e11fbe62cca47002c625f88751f6057f53b34cf6
+SHA512:
+  metadata.gz: feceb84edbb4f1c8d8674a40311fb9799e9bd765d4320f5f550d1ea541724d23b0b2d097f13bbd63b08fcb05551caf2f51431bed42c94cbdcddbf28953db5ba2
+  data.tar.gz: c1838f6da41020899ca68bb7fa4118f535f7b97f90bcb38390147e79817f39548f266383e5ea9008b21d166852dcb7eba75be06751d1ff9393be686c8217934e

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,11 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,117 @@
+# refsheet
+
+Refsheet - the Ruby gem for the Refsheet.net API
+
+The Refsheet.net API allows another application to view and manipulate data on behalf of a user. To get started, [generate an API Key from your account settings](https://refsheet.net/account/settings/api). 
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: v1
+- Package version: 0.1.0
+- Build date: 2020-01-17T12:30:16.510-08:00
+- Build package: class io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build refsheet.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./refsheet-0.1.0.gem
+```
+(for development, run `gem install --dev ./refsheet-0.1.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 'refsheet', '~> 0.1.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 'refsheet', :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 'refsheet'
+
+# Setup authorization
+Refsheet.configure do |config|
+  # Configure API key authorization: apiKeySecret
+  config.api_key['X-ApiKeySecret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-ApiKeySecret'] = 'Bearer'
+
+  # Configure API key authorization: apiKeyId
+  config.api_key['X-ApiKeyId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-ApiKeyId'] = 'Bearer'
+end
+
+api_instance = Refsheet::UsersApi.new
+
+id = "id_example" # String | User GUID
+
+
+begin
+  #Retrieves a User
+  result = api_instance.find(id)
+  p result
+rescue Refsheet::ApiError => e
+  puts "Exception when calling UsersApi->find: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://http://dev1.refsheet.net/api/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Refsheet::UsersApi* | [**find**](docs/UsersApi.md#find) | **GET** /users/{id} | Retrieves a User
+
+
+## Documentation for Models
+
+ - [Refsheet::InlineResponse200](docs/InlineResponse200.md)
+ - [Refsheet::InlineResponse200Data](docs/InlineResponse200Data.md)
+ - [Refsheet::InlineResponse200DataAttributes](docs/InlineResponse200DataAttributes.md)
+ - [Refsheet::InlineResponse200DataAttributesRoles](docs/InlineResponse200DataAttributesRoles.md)
+
+
+## Documentation for Authorization
+
+
+### apiKeySecret
+
+- **Type**: API key
+- **API key parameter name**: X-ApiKeySecret
+- **Location**: HTTP header
+
+### apiKeyId
+
+- **Type**: API key
+- **API key parameter name**: X-ApiKeyId
+- **Location**: HTTP header
+

data/bin/refsheet

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'refsheet'
+
+puts "Refsheet.net CLI, v" + Refsheet::VERSION
+puts
+
+# Setup authorization
+Refsheet.configure do |config|
+  config.scheme = 'http'
+  config.host = 'localhost:5000'
+  config.api_key_id = '4d1aa60b0886fe3f'
+  config.api_key_secret = 'Lh6ZEMUWnuNKssCxDYBvKKu3JLc8WfJkj4hmffREFTA='
+end
+
+users = Refsheet::UsersApi.new
+
+begin
+  username = ARGV[0]
+
+  puts "Searching for user '#{username}'..."
+  # Find User
+  user = users.lookup(username)
+  puts "User ID:   " + user.data.id
+  puts "User Name: " + user.data.attributes.name
+  puts "Username:  " + user.data.attributes.username
+  puts
+  puts "Other Props:"
+  user.data.attributes.to_hash.each do |k, v|
+    puts "  #{k}: #{v}"
+  end
+
+rescue Refsheet::ApiError => e
+  puts "Exception when calling UsersApi->find: #{e}"
+  puts e.message
+end

data/docs/InlineResponse200.md

@@ -0,0 +1,8 @@
+# Refsheet::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**InlineResponse200Data**](InlineResponse200Data.md) |  | [optional] 
+
+

data/docs/InlineResponse200Data.md

@@ -0,0 +1,9 @@
+# Refsheet::InlineResponse200Data
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**attributes** | [**InlineResponse200DataAttributes**](InlineResponse200DataAttributes.md) |  | [optional] 
+
+

data/docs/InlineResponse200DataAttributes.md

@@ -0,0 +1,15 @@
+# Refsheet::InlineResponse200DataAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**username** | **String** |  | 
+**avatar_url** | **String** |  | 
+**profile_image_url** | **String** |  | 
+**is_admin** | **BOOLEAN** |  | [optional] 
+**is_patron** | **BOOLEAN** |  | [optional] 
+**is_supporter** | **BOOLEAN** |  | [optional] 
+**is_moderator** | **BOOLEAN** |  | [optional] 
+
+

data/docs/InlineResponse200DataAttributesRoles.md

@@ -0,0 +1,11 @@
+# Refsheet::InlineResponse200DataAttributesRoles
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**admin** | **BOOLEAN** |  | 
+**patron** | **BOOLEAN** |  | 
+**supporter** | **BOOLEAN** |  | 
+**moderator** | **BOOLEAN** |  | 
+
+

data/docs/UsersApi.md

@@ -0,0 +1,128 @@
+# Refsheet::UsersApi
+
+All URIs are relative to *https://http://dev1.refsheet.net/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**find**](UsersApi.md#find) | **GET** /users/{id} | Retrieve User by ID
+[**lookup**](UsersApi.md#lookup) | **GET** /users/lookup/{username} | Retrieve User by Username
+
+
+# **find**
+> InlineResponse200 find(id)
+
+Retrieve User by ID
+
+Finds a user by ID. The ID supplied should be the hexadecimal user GUID, not the username. To find a user by username, use `/users/lookup/{id}` 
+
+### Example
+```ruby
+# load the gem
+require 'refsheet'
+# setup authorization
+Refsheet.configure do |config|
+  # Configure API key authorization: apiKeySecret
+  config.api_key['X-ApiKeySecret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-ApiKeySecret'] = 'Bearer'
+
+  # Configure API key authorization: apiKeyId
+  config.api_key['X-ApiKeyId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-ApiKeyId'] = 'Bearer'
+end
+
+api_instance = Refsheet::UsersApi.new
+
+id = "id_example" # String | User GUID
+
+
+begin
+  #Retrieve User by ID
+  result = api_instance.find(id)
+  p result
+rescue Refsheet::ApiError => e
+  puts "Exception when calling UsersApi->find: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| User GUID | 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[apiKeySecret](../README.md#apiKeySecret), [apiKeyId](../README.md#apiKeyId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **lookup**
+> InlineResponse200 lookup(username)
+
+Retrieve User by Username
+
+Finds a user by Username. This operation is not case sensitive. Please consider using `/users/{id}` directly if possible. 
+
+### Example
+```ruby
+# load the gem
+require 'refsheet'
+# setup authorization
+Refsheet.configure do |config|
+  # Configure API key authorization: apiKeySecret
+  config.api_key['X-ApiKeySecret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-ApiKeySecret'] = 'Bearer'
+
+  # Configure API key authorization: apiKeyId
+  config.api_key['X-ApiKeyId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-ApiKeyId'] = 'Bearer'
+end
+
+api_instance = Refsheet::UsersApi.new
+
+username = "username_example" # String | Username of the user to find
+
+
+begin
+  #Retrieve User by Username
+  result = api_instance.lookup(username)
+  p result
+rescue Refsheet::ApiError => e
+  puts "Exception when calling UsersApi->lookup: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **username** | **String**| Username of the user to find | 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[apiKeySecret](../README.md#apiKeySecret), [apiKeyId](../README.md#apiKeyId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+