https://github.com/r7kamura/rdmm

An API Client library for DMM Web Service written in Ruby.
https://github.com/r7kamura/rdmm

dmm

Last synced: 3 months ago
JSON representation

An API Client library for DMM Web Service written in Ruby.

• Host: GitHub
• URL: https://github.com/r7kamura/rdmm
• Owner: r7kamura
• License: mit
• Created: 2017-02-07T11:52:36.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-26T17:26:52.000Z (over 6 years ago)
• Last Synced: 2024-10-06T03:56:31.680Z (3 months ago)
• Topics: dmm
• Language: Ruby
• Homepage:
• Size: 39.1 KB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rdmm

[![CircleCI](https://img.shields.io/circleci/project/github/r7kamura/rdmm.svg)](https://circleci.com/gh/r7kamura/rdmm)

[![Gem Version](https://badge.fury.io/rb/rdmm.svg)](https://rubygems.org/gems/rdmm)

[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/github/r7kamura/rdmm)

An API Client library for DMM Web Service written in Ruby.

See https://affiliate.dmm.com/api/ for more details about DMM Web Service.

## Requirements

- Ruby 2.2.2 or higher

## Installation

Add this line to your application's Gemfile:

```ruby

gem "rdmm"

```

And then execute:

```bash

bundle

```

Or install it yourself as:

```bash

gem install rdmm

```

## Usage

### Rdmm::Client.new

```ruby

require "rdmm"

client = Rdmm::Client.new(affiliate_id: "dummy", api_id: "dummy")

```

### Rdmm::Client#list_actresses

Available options:

- `:id`

- `:birthday_from`

- `:birthday_to`

- `:bust_from`

- `:bust_to`

- `:height_from`

- `:height_to`

- `:hip_from`

- `:hip_to`

- `:hits`

- `:initial`

- `:keyword`

- `:offset`

- `:sort`

- `:waist_from`

- `:waist_to`

```ruby

client.list_actresses

```

`https://api.dmm.com/affiliate/v3/ActressSearch?affiliate_id=dummy&api_id=dummy`

### Rdmm::Client#list_authors

Available options:

- `:floor_id`

- `:hits`

- `:initial`

- `:offset`

```ruby

client.list_authors(floor_id: 27)

```

`https://api.dmm.com/affiliate/v3/AuthorSearch?affiliate_id=dummy&api_id=dummy&floor_id=27`

### Rdmm::Client#list_floors

```ruby

client.list_floors

```

`https://api.dmm.com/affiliate/v3/FloorList?affiliate_id=dummy&api_id=dummy`

### Rdmm::Client#list_genres

Available options:

- `:floor_id`

- `:hits`

- `:initial`

- `:offset`

```ruby

client.list_genres(floor_id: 27)

```

`https://api.dmm.com/affiliate/v3/GenreSearch?affiliate_id=dummy&api_id=dummy&floor_id=27`

### Rdmm::Client#list_items

Available options:

- `:article`

- `:article_id`

- `:content_id`

- `:floor_code`

- `:hits`

- `:keyword`

- `:mono_stock`

- `:offset`

- `:released_from`

- `:released_to`

- `:service_code`

- `:site`

- `:sort`

```ruby

client.list_items(site: "DMM.com")

```

`https://api.dmm.com/affiliate/v3/ItemList?affiliate_id=dummy&api_id=dummy&site=DMM.com`

### Rdmm::Client#list_makers

Available options:

- `:floor_id`

- `:hits`

- `:initial`

- `:offset`

```ruby

client.list_makers(floor_id: 27)

```

`https://api.dmm.com/affiliate/v3/MakerSearch?affiliate_id=dummy&api_id=dummy&floor_id=27`

### Rdmm::Client#list_series

Available options:

- `:floor_id`

- `:hits`

- `:initial`

- `:offset`

```ruby

client.list_series(floor_id: 27)

```

`https://api.dmm.com/affiliate/v3/SeriesSearch?affiliate_id=dummy&api_id=dummy&floor_id=27`

### Rdmm::Responses::BaseResponse

Available methods:

- `#body`

- `#each`

- `#errors`

- `#first_position`

- `#has_error?`

- `#has_next_page?`

- `#headers`

- `#message`

- `#next_page_offset`

- `#resources`

- `#result_count`

- `#status`

- `#total_count`

### Rdmm::Resources::ActressResource

Available methods:

- `#birthday`

- `#blood_type`

- `#bust`

- `#cup`

- `#height`

- `#hobbies`

- `#id`

- `#image_url_large`

- `#image_url_small`

- `#list_url_digital`

- `#list_url_mono`

- `#list_url_monthly`

- `#list_url_ppm`

- `#list_url_rental`

- `#name`

- `#prefectures`

- `#ruby`

- `#waist`

### Rdmm::Resources::AuthorResource

Available methods:

- `#another_name`

- `#id`

- `#list_url`

- `#name`

- `#ruby`

### Rdmm::Resources::FloorResource

Available methods:

- `#code`

- `#id`

- `#name`

- `#service_code`

- `#service_name`

- `#site_code`

- `#site_name`

### Rdmm::Resources::GenreResource

Available methods:

- `#id`

- `#list_url`

- `#name`

- `#ruby`

### Rdmm::Resources::ItemResource

Available methods:

- `#actors`

- `#actresses`

- `#authors`

- `#bandai_title_code`

- `#category_name`

- `#cd_kind`

- `#compatible_with_pc?`

- `#compatible_with_sp?`

- `#content_id`

- `#directors`

- `#floor_code`

- `#floor_name`

- `#genres`

- `#isbn`

- `#jancode`

- `#labels`

- `#maker_product`

- `#makers`

- `#number`

- `#price`

- `#price_deliveries`

- `#price_proper`

- `#product_id`

- `#released_at`

- `#review_average`

- `#review_count`

- `#series`

- `#service_code`

- `#service_name`

- `#stock`

- `#stock`

- `#title`

- `#url`

- `#url_affiliate`

- `#url_image_large`

- `#url_image_list`

- `#url_image_samples`

- `#url_image_small`

- `#url_movie_sample_size_476_306`

- `#url_movie_sample_size_560_360`

- `#url_movie_sample_size_644_414`

- `#url_movie_sample_size_720_480`

- `#url_sp`

- `#url_sp_affiliate`

- `#url_tachiyomi`

- `#url_tachiyomi_affiliate`

- `#volume`

### Rdmm::Resources::MakerResource

Available methods:

- `#id`

- `#list_url`

- `#name`

- `#ruby`

### Rdmm::Resources::SeriesResource

Available methods:

- `#id`

- `#list_url`

- `#name`

- `#ruby`