rdmm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fdf2276f123620c09e7985eaa349ae3aed3b946
+  data.tar.gz: 5179c7024474006ca8c2cf34fca0355f4b8cd26c
+SHA512:
+  metadata.gz: 6d667c0451e4a6fadb17ae3b994134f09d3f459e9f3018f7c3bcb3dfd7fcf6e47fb456b3808231143118ea3dbc7d49abf706984f66d9476abd85fa4b3bfae706
+  data.tar.gz: 36bce25c65eb0dd6acf5965a01f58d19b7990d1cf3229bd4c32e157b1b9b5aa9b9f7114b14c3c069cc248260b2d16bba877fc6265ef4019c100843f6322972f3

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.0.1
+
+- 1st Release :tada:
+- Add `Rdmm::Client#list_items`

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rdmm.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Ryo Nakamura
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+# Rdmm
+
+An API Client library for DMM written in Ruby.
+
+## 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_items
+
+Available options:
+
+- `:article`
+- `:article_id`
+- `:content_id`
+- `:floor`
+- `:hits`
+- `:keyword`
+- `:mono_stock`
+- `:offset`
+- `:released_from`
+- `:released_to`
+- `:service`
+- `: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::Resources::ItemResource
+
+Available attributes:
+
+- `actors`
+- `actresses`
+- `affiliate_url`
+- `authors`
+- `category_name`
+- `content_id`
+- `directors`
+- `floor_code`
+- `floor_name`
+- `genres`
+- `labels`
+- `makers`
+- `prices`
+- `product_id`
+- `released_at`
+- `review_avarage`
+- `review_count`
+- `series_list`
+- `service_code`
+- `service_name`
+- `title`
+- `url`
+- `volume`
+
+```ruby
+client.list_items(site: "DMM.com").first.title
+```
+
+<details>
+<summary>output</summary>
+
+```ruby
+"キングダム"
+```
+
+</details>

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rdmm.rb

@@ -0,0 +1,8 @@
+require "rdmm/client"
+require "rdmm/queries/base_query"
+require "rdmm/queries/list_items_query"
+require "rdmm/resources/base_resource"
+require "rdmm/resources/item_resource"
+require "rdmm/responses/base_response"
+require "rdmm/responses/list_items_response"
+require "rdmm/version"

data/lib/rdmm/client.rb

@@ -0,0 +1,52 @@
+require "faraday"
+require "faraday_middleware"
+
+module Rdmm
+  class Client
+    BASE_URL = "https://api.dmm.com"
+    PATH_TO_LIST_ITEMS = "/affiliate/v3/ItemList"
+
+    # @param affiliate_id [String]
+    # @param api_id [String]
+    def initialize(affiliate_id:, api_id:)
+      @affiliate_id = affiliate_id
+      @api_id = api_id
+    end
+
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= ::Faraday::Connection.new(url: BASE_URL) do |connection|
+        connection.adapter :net_http
+        connection.response :json
+        connection.response :raise_error
+      end
+    end
+
+    # @param options [Hash]
+    # @return [Rdmm::Responses::ListItemsResponse]
+    def list_items(options = {})
+      query_options = default_query_options.merge(options)
+      query = ::Rdmm::Queries::ListItemsQuery.new(query_options)
+      faraday_response = get(PATH_TO_LIST_ITEMS, query.to_hash)
+      ::Rdmm::Responses::ListItemsResponse.new(faraday_response)
+    end
+
+    private
+
+    # @return [Hash]
+    def default_query_options
+      {
+        affiliate_id: @affiliate_id,
+        api_id: @api_id,
+      }
+    end
+
+    # @private
+    # @param path [String]
+    # @param query [Hash]
+    # @return [Faraday::Response]
+    def get(path, query)
+      connection.get(path, query)
+    end
+  end
+end

data/lib/rdmm/queries/base_query.rb

@@ -0,0 +1,59 @@
+module Rdmm
+  module Queries
+    class BaseQuery
+      class << self
+        attr_writer :property_names
+
+        # @note Override
+        def inherited(child_class)
+          child_class.property_names = property_names.clone
+        end
+
+        # @return [Array<Symbol>]
+        def property_names
+          @property_names ||= []
+        end
+
+        # @param property_name [Symbol]
+        def property(property_name)
+          property_names << property_name
+        end
+      end
+
+      property :affiliate_id
+      property :api_id
+
+      # @param options [Hash]
+      def initialize(options = {})
+        @options = options
+      end
+
+      # @return [String]
+      def affiliate_id
+        options[:affiliate_id]
+      end
+
+      # @return [String]
+      def api_id
+        options[:api_id]
+      end
+
+      # @return [Hash]
+      def to_hash
+        self.class.property_names.each_with_object({}) do |property_name, result|
+          value = send(property_name)
+          unless value.nil?
+            result[property_name.to_s] = value
+          end
+        end
+      end
+
+      private
+
+      # @return [Hash]
+      def options
+        @options
+      end
+    end
+  end
+end

data/lib/rdmm/queries/list_items_query.rb

@@ -0,0 +1,118 @@
+module Rdmm
+  module Queries
+    class ListItemsQuery < BaseQuery
+      property :article
+      property :article_id
+      property :cid
+      property :floor
+      property :gte_date
+      property :hits
+      property :keyword
+      property :lte_date
+      property :mono_stock
+      property :offset
+      property :service
+      property :site
+      property :sort
+
+      # @note One of the following values:
+      #   "actress"
+      #   "author"
+      #   "genre"
+      #   "maker"
+      #   "series"
+      # @return [String, nil]
+      def article
+        options[:article]
+      end
+
+      # @return [String, nil]
+      def article_id
+        options[:article_id]
+      end
+
+      # @return [String, nil]
+      def cid
+        options[:content_id]
+      end
+
+      # @note floor code
+      # @return [String, nil]
+      def floor
+        options[:floor]
+      end
+
+      # @return [String, nil]
+      def gte_date
+        if options[:released_from]
+          format_time(options[:released_from])
+        end
+      end
+
+      # @return [Integer, nil]
+      def hits
+        options[:hits]
+      end
+
+      # @return [String, nil]
+      def keyword
+        options[:keyword]
+      end
+
+      # @return [String, nil]
+      def lte_date
+        if options[:released_to]
+          format_time(options[:released_to])
+        end
+      end
+
+      # @note One of the following values:
+      #   "dmp"
+      #   "mono"
+      #   "reserve"
+      #   "stock"
+      # @return [String, nil]
+      def mono_stock
+        options[:mono_stock]
+      end
+
+      # @return [Integer, nil]
+      def offset
+        options[:offset]
+      end
+
+      # @note service code
+      # @return [String, nil]
+      def service
+        options[:service]
+      end
+
+      # @note One of the following values:
+      #   "DMM.com"
+      #   "DMM.R18"
+      # @return [String, nil]
+      def site
+        options[:site]
+      end
+
+      # @note One of the following values:
+      #   "-price"
+      #   "date"
+      #   "price"
+      #   "rank"
+      #   "review"
+      # @return [String, nil]
+      def sort
+        options[:sort]
+      end
+
+      private
+
+      # @param time [Time]
+      # @return [String]
+      def format_time(time)
+        time.strftime("%Y-%m-%dT%H:%M:%S")
+      end
+    end
+  end
+end

data/lib/rdmm/resources/base_resource.rb

@@ -0,0 +1,13 @@
+module Rdmm
+  module Resources
+    class BaseResource
+      # @return [Hash]
+      attr_reader :source
+
+      # @param source [Hash]
+      def initialize(source)
+        @source = source
+      end
+    end
+  end
+end

data/lib/rdmm/resources/item_resource.rb

@@ -0,0 +1,124 @@
+require "time"
+
+module Rdmm
+  module Resources
+    class ItemResource < BaseResource
+      # @return [Array]
+      def actresses
+        Array(source["iteminfo"]["actress"])
+      end
+
+      # @return [Array]
+      def actors
+        Array(source["iteminfo"]["actor"])
+      end
+
+      # @return [String, nil]
+      def affiliate_url
+        source["affiliate_url"]
+      end
+
+      # @return [Array]
+      def authors
+        Array(source["iteminfo"]["author"])
+      end
+
+      # @return [String, nil]
+      def category_name
+        source["category_name"]
+      end
+
+      # @return [String, nil]
+      def content_id
+        source["content_id"]
+      end
+
+      # @return [Array]
+      def directors
+        Array(source["iteminfo"]["director"])
+      end
+
+      # @return [String, nil]
+      def floor_code
+        source["floor_code"]
+      end
+
+      # @return [String, nil]
+      def floor_name
+        source["floor_name"]
+      end
+
+      # @return [Array]
+      def genres
+        Array(source["iteminfo"]["genre"])
+      end
+
+      # @return [Array]
+      def labels
+        Array(source["iteminfo"]["label"])
+      end
+
+      # @return [Array]
+      def makers
+        Array(source["iteminfo"]["maker"])
+      end
+
+      # @return [Hash, nil]
+      def prices
+        source["prices"]
+      end
+
+      # @return [String, nil]
+      def product_id
+        source["product_id"]
+      end
+
+      # @return [Time, nil]
+      def released_at
+        if source["date"]
+          ::Time.parse(source["date"])
+        end
+      end
+
+      # @return [Integer, nil]
+      def review_avarage
+        source["review"]["count"]
+      end
+
+      # @return [Float, nil]
+      def review_count
+        source["review"]["count"]
+      end
+
+      # @return [Array]
+      def series_list
+        Array(source["iteminfo"]["series"])
+      end
+
+      # @return [String, nil]
+      def service_code
+        source["service_code"]
+      end
+
+      # @return [String, nil]
+      def service_name
+        source["service_name"]
+      end
+
+      # @return [String, nil]
+      def title
+        source["title"]
+      end
+
+      # @return [String, nil]
+      def url
+        source["url"]
+      end
+
+      # @return [Integer, nil]
+      def volume
+        source["volume"]
+      end
+    end
+  end
+end

data/lib/rdmm/responses/base_response.rb

@@ -0,0 +1,44 @@
+module Rdmm
+  module Responses
+    class BaseResponse
+      include ::Enumerable
+
+      # @param faraday_response [Faraday::Response]
+      def initialize(faraday_response)
+        @faraday_response = faraday_response
+      end
+
+      # @return [String]
+      def body
+        faraday_response.body
+      end
+
+      # @note Implementation for Enumerable
+      def each(&block)
+        resources.each(&block)
+      end
+
+      # @return [Faraday::Utils::Headers]
+      def headers
+        faraday_response.headers
+      end
+
+      # @return [Rdmm::Resources::BaseResource]
+      def resources
+        raise ::NotImplementedError
+      end
+
+      # @return [Integer]
+      def status
+        faraday_response.status
+      end
+
+      private
+
+      # @return [Faraday::Response]
+      def faraday_response
+        @faraday_response
+      end
+    end
+  end
+end

data/lib/rdmm/responses/list_items_response.rb

@@ -0,0 +1,12 @@
+module Rdmm
+  module Responses
+    class ListItemsResponse < BaseResponse
+      # @note Override
+      def resources
+        body["result"]["items"].map do |source|
+          ::Rdmm::Resources::ItemResource.new(source)
+        end
+      end
+    end
+  end
+end

data/lib/rdmm/version.rb

@@ -0,0 +1,3 @@
+module Rdmm
+  VERSION = "0.0.1"
+end

data/rdmm.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rdmm/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rdmm"
+  spec.version       = Rdmm::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "An API Client library for DMM written in Ruby."
+  spec.homepage      = "https://github.com/r7kamura/rdmm"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: rdmm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rdmm.rb
+- lib/rdmm/client.rb
+- lib/rdmm/queries/base_query.rb
+- lib/rdmm/queries/list_items_query.rb
+- lib/rdmm/resources/base_resource.rb
+- lib/rdmm/resources/item_resource.rb
+- lib/rdmm/responses/base_response.rb
+- lib/rdmm/responses/list_items_response.rb
+- lib/rdmm/version.rb
+- rdmm.gemspec
+homepage: https://github.com/r7kamura/rdmm
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: An API Client library for DMM written in Ruby.
+test_files: []