osdn-client

OSDNClient - the Ruby gem for the OSDN REST API v0 beta

OSDN REST API. Currently this API is experimental release. Pelase refer documentation on https://osdn.net/projects/osdn-codes/wiki/APIGuide and you can get client libraries from https://osdn.net/projects/osdn-codes/releases/p14859 .

This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.20161003
• Package version: 0.0.20161003
• Build date: 2016-10-04T16:32:42.213+09:00
• Build package: class io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://osdn.net/projects/osdn-codes/wiki/APIGuide

Installation

Build a gem

To build the Ruby code into a gem:

gem build osdn-client.gemspec

Then either install the gem locally:

gem install ./osdn-client-0.0.20161003.gem

(for development, run gem install --dev ./osdn-client-0.0.20161003.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'osdn-client', '~> 0.0.20161003'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/OSDN/Client, then add the following in the Gemfile:

gem 'osdn-client', :git => 'https://github.com/OSDN/Client.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'osdn-client'

# Setup authorization
OSDNClient.configure do |config|
  # Configure OAuth2 access token for authorization: oauth2-code
  config.access_token = 'YOUR ACCESS TOKEN'

  # Configure OAuth2 access token for authorization: oauth2-implicit
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = OSDNClient::DefaultApi.new

begin
  result = api_instance.ping
  p result
rescue OSDNClient::ApiError => e
  puts "Exception when calling DefaultApi->ping: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://osdn.net/api/v0

Class	Method	HTTP request	Description
OSDNClient::DefaultApi	ping	GET /ping
OSDNClient::DefaultApi	token	POST /token
OSDNClient::ProjectApi	create_news	POST /news
OSDNClient::ProjectApi	create_news_0	POST /project/id_or_name/news
OSDNClient::ProjectApi	create_package	POST /project/id_or_name/frs
OSDNClient::ProjectApi	create_release	POST /project/id_or_name/frs/package_id
OSDNClient::ProjectApi	create_release_file	POST /project/id_or_name/frs/package_id/release_id
OSDNClient::ProjectApi	delete_news	DELETE /news/news_id
OSDNClient::ProjectApi	delete_news_0	DELETE /project/id_or_name/news/news_id
OSDNClient::ProjectApi	delete_package	DELETE /project/id_or_name/frs/package_id
OSDNClient::ProjectApi	delete_release	DELETE /project/id_or_name/frs/package_id/release_id
OSDNClient::ProjectApi	delete_release_file	DELETE /project/id_or_name/frs/package_id/release_id/file_id
OSDNClient::ProjectApi	draft_release	GET /project/id_or_name/frs/package_id/draft
OSDNClient::ProjectApi	get_news	GET /news/news_id
OSDNClient::ProjectApi	get_news_0	GET /project/id_or_name/news/news_id
OSDNClient::ProjectApi	get_package	GET /project/id_or_name/frs/package_id
OSDNClient::ProjectApi	get_project	GET /project/id_or_name
OSDNClient::ProjectApi	get_release	GET /project/id_or_name/frs/package_id/release_id
OSDNClient::ProjectApi	get_release_file	GET /project/id_or_name/frs/package_id/release_id/file_id
OSDNClient::ProjectApi	list_news	GET /news
OSDNClient::ProjectApi	list_news_0	GET /project/id_or_name/news
OSDNClient::ProjectApi	list_packages	GET /project/id_or_name/frs
OSDNClient::ProjectApi	update_news	PATCH /news/news_id
OSDNClient::ProjectApi	update_news_0	PATCH /project/id_or_name/news/news_id
OSDNClient::ProjectApi	update_package	PATCH /project/id_or_name/frs/package_id
OSDNClient::ProjectApi	update_release	PATCH /project/id_or_name/frs/package_id/release_id
OSDNClient::ProjectApi	update_release_file	PATCH /project/id_or_name/frs/package_id/release_id/file_id
OSDNClient::ProjectFrsApi	create_package	POST /project/id_or_name/frs
OSDNClient::ProjectFrsApi	create_release	POST /project/id_or_name/frs/package_id
OSDNClient::ProjectFrsApi	create_release_file	POST /project/id_or_name/frs/package_id/release_id
OSDNClient::ProjectFrsApi	delete_package	DELETE /project/id_or_name/frs/package_id
OSDNClient::ProjectFrsApi	delete_release	DELETE /project/id_or_name/frs/package_id/release_id
OSDNClient::ProjectFrsApi	delete_release_file	DELETE /project/id_or_name/frs/package_id/release_id/file_id
OSDNClient::ProjectFrsApi	draft_release	GET /project/id_or_name/frs/package_id/draft
OSDNClient::ProjectFrsApi	get_package	GET /project/id_or_name/frs/package_id
OSDNClient::ProjectFrsApi	get_release	GET /project/id_or_name/frs/package_id/release_id
OSDNClient::ProjectFrsApi	get_release_file	GET /project/id_or_name/frs/package_id/release_id/file_id
OSDNClient::ProjectFrsApi	list_packages	GET /project/id_or_name/frs
OSDNClient::ProjectFrsApi	update_package	PATCH /project/id_or_name/frs/package_id
OSDNClient::ProjectFrsApi	update_release	PATCH /project/id_or_name/frs/package_id/release_id
OSDNClient::ProjectFrsApi	update_release_file	PATCH /project/id_or_name/frs/package_id/release_id/file_id
OSDNClient::ProjectNewsApi	create_news	POST /news
OSDNClient::ProjectNewsApi	create_news_0	POST /project/id_or_name/news
OSDNClient::ProjectNewsApi	delete_news	DELETE /news/news_id
OSDNClient::ProjectNewsApi	delete_news_0	DELETE /project/id_or_name/news/news_id
OSDNClient::ProjectNewsApi	get_news	GET /news/news_id
OSDNClient::ProjectNewsApi	get_news_0	GET /project/id_or_name/news/news_id
OSDNClient::ProjectNewsApi	list_news	GET /news
OSDNClient::ProjectNewsApi	list_news_0	GET /project/id_or_name/news
OSDNClient::ProjectNewsApi	update_news	PATCH /news/news_id
OSDNClient::ProjectNewsApi	update_news_0	PATCH /project/id_or_name/news/news_id
OSDNClient::UserApi	get_user	GET /user/id_or_name

Documentation for Models

• OSDNClient::Group
• OSDNClient::GroupToolFlags
• OSDNClient::News
• OSDNClient::Package
• OSDNClient::Pong
• OSDNClient::RelFile
• OSDNClient::Release
• OSDNClient::SimpleChamber
• OSDNClient::SimpleGroup
• OSDNClient::SimpleUser
• OSDNClient::Skill
• OSDNClient::Token
• OSDNClient::User

Documentation for Authorization

oauth2-code

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://osdn.net/account/oauth2ui/authorize
• Scopes:
  • profile: Read basic user profile
  • group: read access to group data
  • group_write: write access to group data
  • chamber: read access to chamber data
  • chamber_write: write access to chamber data

oauth2-implicit

• Type: OAuth
• Flow: implicit
• Authorization URL: https://osdn.net/account/oauth2ui/authorize
• Scopes:
  • profile: Read basic user profile
  • group: read access to group data
  • group_write: write access to group data
  • chamber: read access to chamber data
  • chamber_write: write access to chamber data