metatron_ruby_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dda82d8008291b270cf2cca2d89295721b33212c
+  data.tar.gz: 7447040efd122f2870b370a5a1efa6b0c68198d6
+SHA512:
+  metadata.gz: 41e6d7f8ed5ed2e105afde36c8104a15b7555ac5730c86017dc8aa26bef8e8d17e9cc7376dbe43737b867b81bce5001659c5b5f798a13ec9ec2d2707ddf09ca3
+  data.tar.gz: 8509bc4aa6038f797d69e61ff0a34f28d70a075fd97a6347286532de370b777b4f51a115c5f51ef791b9d510f63b10af0648c464a8bc50d59cdb490ec740d5e2

data/README.md

@@ -0,0 +1,140 @@
+# metatron_ruby_client
+
+MetatronClient - the Ruby gem for the Metatron Server
+
+A primitive modelling bibliographic metadata
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 2016-07-15T09:42:29Z
+- Package version: 0.0.1
+- Build date: 2016-07-15T12:44:14.686+01:00
+- Build package: class io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build metatron_ruby_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./metatron_ruby_client-0.0.1.gem
+```
+(for development, run `gem install --dev ./metatron_ruby_client-0.0.1.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 'metatron_ruby_client', '~> 0.0.1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/talis/metatron_rb, then add the following in the Gemfile:
+
+    gem 'metatron_ruby_client', :git => 'https://github.com/talis/metatron_rb.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 'metatron_ruby_client'
+
+# Setup authorization
+MetatronClient.configure do |config|
+  # Configure API key authorization: Authorizer
+  config.api_key['Authorization'] = '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['Authorization'] = 'BEARER'
+end
+
+api_instance = MetatronClient::DefaultApi.new
+
+asset_id = "asset_id_example" # String | 
+
+asset_type = "asset_type_example" # String | 
+
+authorization = "authorization_example" # String | 
+
+
+begin
+  api_instance.2_assets_asset_type_asset_id_delete(asset_id, asset_type, authorization)
+rescue MetatronClient::ApiError => e
+  puts "Exception when calling DefaultApi->2_assets_asset_type_asset_id_delete: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://bibliography.talis.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MetatronClient::DefaultApi* | [**2_assets_asset_type_asset_id_delete**](docs/DefaultApi.md#2_assets_asset_type_asset_id_delete) | **DELETE** /2/assets/{assetType}/{assetId} | 
+*MetatronClient::DefaultApi* | [**2_manifestations_get**](docs/DefaultApi.md#2_manifestations_get) | **GET** /2/manifestations | 
+*MetatronClient::DefaultApi* | [**2_manifestations_manifestation_id_assets_get**](docs/DefaultApi.md#2_manifestations_manifestation_id_assets_get) | **GET** /2/manifestations/{manifestationId}/assets | 
+*MetatronClient::DefaultApi* | [**2_manifestations_manifestation_id_assets_post**](docs/DefaultApi.md#2_manifestations_manifestation_id_assets_post) | **POST** /2/manifestations/{manifestationId}/assets | 
+*MetatronClient::DefaultApi* | [**2_manifestations_manifestation_id_get**](docs/DefaultApi.md#2_manifestations_manifestation_id_get) | **GET** /2/manifestations/{manifestationId} | 
+*MetatronClient::DefaultApi* | [**2_manifestations_manifestation_id_items_tenant_code_get**](docs/DefaultApi.md#2_manifestations_manifestation_id_items_tenant_code_get) | **GET** /2/manifestations/{manifestationId}/items/{tenantCode} | 
+*MetatronClient::DefaultApi* | [**2_manifestations_manifestation_id_works_get**](docs/DefaultApi.md#2_manifestations_manifestation_id_works_get) | **GET** /2/manifestations/{manifestationId}/works | 
+*MetatronClient::DefaultApi* | [**2_works_get**](docs/DefaultApi.md#2_works_get) | **GET** /2/works | 
+*MetatronClient::DefaultApi* | [**2_works_work_id_assets_get**](docs/DefaultApi.md#2_works_work_id_assets_get) | **GET** /2/works/{workId}/assets | 
+*MetatronClient::DefaultApi* | [**2_works_work_id_manifestations_get**](docs/DefaultApi.md#2_works_work_id_manifestations_get) | **GET** /2/works/{workId}/manifestations | 
+*MetatronClient::DefaultApi* | [**2_works_work_id_similar_get**](docs/DefaultApi.md#2_works_work_id_similar_get) | **GET** /2/works/{workId}/similar | 
+
+
+## Documentation for Models
+
+ - [MetatronClient::Asset](docs/Asset.md)
+ - [MetatronClient::AssetData](docs/AssetData.md)
+ - [MetatronClient::AssetResultSet](docs/AssetResultSet.md)
+ - [MetatronClient::AssetResultSetMeta](docs/AssetResultSetMeta.md)
+ - [MetatronClient::Error](docs/Error.md)
+ - [MetatronClient::Errors](docs/Errors.md)
+ - [MetatronClient::ItemData](docs/ItemData.md)
+ - [MetatronClient::ItemResultSet](docs/ItemResultSet.md)
+ - [MetatronClient::Links](docs/Links.md)
+ - [MetatronClient::ManifestationAttributes](docs/ManifestationAttributes.md)
+ - [MetatronClient::ManifestationData](docs/ManifestationData.md)
+ - [MetatronClient::ManifestationRelationships](docs/ManifestationRelationships.md)
+ - [MetatronClient::ManifestationResultSet](docs/ManifestationResultSet.md)
+ - [MetatronClient::OneToManyRelationship](docs/OneToManyRelationship.md)
+ - [MetatronClient::OneToOneRelationship](docs/OneToOneRelationship.md)
+ - [MetatronClient::ResourceData](docs/ResourceData.md)
+ - [MetatronClient::ResourceLink](docs/ResourceLink.md)
+ - [MetatronClient::ResultSetMeta](docs/ResultSetMeta.md)
+ - [MetatronClient::WorkAttributes](docs/WorkAttributes.md)
+ - [MetatronClient::WorkData](docs/WorkData.md)
+ - [MetatronClient::WorkRelationships](docs/WorkRelationships.md)
+ - [MetatronClient::WorkResultSet](docs/WorkResultSet.md)
+
+
+## Documentation for Authorization
+
+
+### oauth2
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - su: Talis super user
+  - metatron:read: Read only access
+  - metatron:write: Write only access
+

data/config.json

@@ -0,0 +1,13 @@
+{
+    "gemName": "metatron_ruby_client",
+    "moduleName": "MetatronClient",
+    "gemVersion": "0.0.1",
+    "gemLicense": "Copyright Talis Education Ltd",
+    "gemHomepage": "https://github.com/talis/metatron_rb",
+    "gemSummary": "A ruby API wrapper for Metatron",
+    "gemDescription": "A client to utilise the bibliographic data and work set groupings in Metatron",
+    "gemAuthor": "Ross Singer",
+    "gemAuthorEmail": "rxs@talis.com",
+    "gitUserId": "talis",
+    "gitRepoId": "metatron_rb"
+}

data/docs/Asset.md

@@ -0,0 +1,9 @@
+# MetatronClient::Asset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**AssetResultSetMeta**](AssetResultSetMeta.md) |  | [optional] 
+**data** | [**AssetData**](AssetData.md) |  | 
+
+

data/docs/AssetAttributes.md

@@ -0,0 +1,8 @@
+# MetatronClient::AssetAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asset_type** | **String** |  | 
+
+

data/docs/AssetData.md

@@ -0,0 +1,10 @@
+# MetatronClient::AssetData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**type** | **String** |  | 
+**attributes** | **Object** |  | [optional] 
+
+

data/docs/AssetMeta.md

@@ -0,0 +1,8 @@
+# MetatronClient::AssetMeta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**super_type** | **String** |  | [optional] 
+
+

data/docs/AssetResultSet.md

@@ -0,0 +1,10 @@
+# MetatronClient::AssetResultSet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**Links**](Links.md) |  | [optional] 
+**meta** | [**AssetResultSetMeta**](AssetResultSetMeta.md) |  | [optional] 
+**data** | [**Array<AssetData>**](AssetData.md) |  | [optional] 
+
+

data/docs/AssetResultSetMeta.md

@@ -0,0 +1,8 @@
+# MetatronClient::AssetResultSetMeta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**super_type** | **String** |  | [optional] 
+
+