dmm 0.0.2.1 → 0.0.3

data/README.md

@@ -16,7 +16,7 @@ Or install it yourself as:
 
     $ gem install dmm
 
-## ChnageLog
+## ChangeLog
 
 ### Version 0.0.2
 

data/dmm.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday_middleware', '~> 0.8'
   gem.add_dependency 'nokogiri', '~> 1.5.6'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
 end

data/lib/dmm/api/items.rb

@@ -0,0 +1,30 @@
+require 'dmm/response'
+require 'dmm/core_ext/hash'
+require 'dmm/core_ext/string'
+
+module Dmm
+  module API
+    module Items
+
+      # Returns a Dmm::Response object
+      #
+      # @param options [Hash]
+      # @return [Dmm::Response]
+      def item_list(options={})
+        res = Hash.from_xml(get('/', params(options)))
+        raise Dmm::Error, error_message(res) if res[:response][:result][:errors]
+        Dmm::Response.new(res)
+      end
+
+      private
+
+      def error_message(response)
+        result     = response[:response][:result]
+        message    = result[:message] || "Error"
+        error_name = "\s(#{result[:errors][:error][:name]})"
+        error_val  = result[:errors][:error][:value] || ""
+        "#{message.camelize}: #{error_val.capitalize}#{error_name}"
+      end
+    end
+  end
+end

data/lib/dmm/client.rb

@@ -1,15 +1,14 @@
 require 'dmm'
-require 'dmm/response'
-require 'dmm/item'
 require 'dmm/error'
-require 'dmm/core_ext/hash'
-require 'dmm/core_ext/string'
+require 'dmm/api/items'
 require 'faraday'
 require 'faraday_middleware'
 require 'faraday/response/raise_dmm_error'
 
 module Dmm
   class Client
+    include Dmm::API::Items
+
     ROOT_URL = 'http://affiliate-api.dmm.com'
     API_VERSION = '2.00'
     COM = 'DMM.com'
@@ -18,20 +17,17 @@ module Dmm
 
     attr_accessor *OPTIONS
 
-    def initialize(args)
+    # Initialize a new Client object
+    #
+    # @param options [Hash]
+    # @return [Dmm::Client]
+    def initialize(options={})
       OPTIONS.each do |id|
-        send("#{id}=", args[id])
+        send("#{id}=", options[id])
       end
     end
 
-    # @return [Dmm::Response]
-    def item_list(options={})
-      res = get('/', params(options))
-      raise Dmm::Error, error_message(res) if res[:response][:result][:errors]
-      Dmm::Response.new(res)
-    end
-
-    # @return [Hash]
+    # Perform an HTTP GET request
     def get(path, params={})
       request(:get, path, params)
     end
@@ -42,9 +38,12 @@ module Dmm
       response = connection.send(method.to_sym, path, params) do |request|
         request.url(path, params)
       end
-      Hash.from_xml(response.body)
+      response.body
     end
 
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
     def connection
       @connection ||= Faraday.new(:url => ROOT_URL) do |builder|
         builder.request  :url_encoded
@@ -53,6 +52,10 @@ module Dmm
       end
     end
 
+    # Returns a Hash containing API query parameters
+    #
+    # @param [Hash]
+    # @return [Hash]
     def params(options={})
       params = {
         :api_id       => @api_id,
@@ -65,13 +68,5 @@ module Dmm
       options.each_value {|val| val.encode! 'euc-jp' if val.kind_of? String}
       params.merge!(options)
     end
-
-    def error_message(response)
-      result     = response[:response][:result]
-      message    = result[:message] || "Error"
-      error_name = "\s(#{result[:errors][:error][:name]})"
-      error_val  = result[:errors][:error][:value] || ""
-      "#{message.camelize}: #{error_val.capitalize}#{error_name}"
-    end
   end
 end

data/lib/dmm/item.rb

@@ -15,17 +15,24 @@ module Dmm
     alias :url_sp :URLsp
     alias :affiliate_url_sp :affiliateURLsp
 
+    # Returns an Array of sampleimage url
+    #
+    # @return [Array<String>]
     def sampleImageURL
       @attrs[:sampleImageURL][:sample_s][:image]
     end
     alias :sample_image_url :sampleImageURL
 
+    # Returns a Dmm::Price object
+    #
     # @return [Dmm::Price]
     def prices
       @price ||= Dmm::Price.new(@attrs[:prices])
       @price
     end
 
+    # Returns a Dmm::Iteminfo object
+    #
     # @return [Dmm::Iteminfo]
     def iteminfo
       @iteminfo ||= Dmm::Iteminfo.new(@attrs[:iteminfo])

data/lib/dmm/price.rb

@@ -4,24 +4,29 @@ module Dmm
   class Price < Dmm::Base
     attr_reader :price
 
+    # Returns minimum price of item
+    #
     # @return [Integer]
     def min_price
       @attrs[:price].to_i
     end
 
-    # @return [Array]
+    # Returns an array of hashes with a type of delivery as key and price as value
+    #
+    # @return [Array<Hash>]
     def deliveries
       return [] unless @attrs[:deliveries]
       @attrs[:deliveries][:delivery]
     end
 
+    # Returns an array containing type of delivery
+    #
     # @return [Array]
     def delivery_types
       @delivery_types ||= deliveries.map { |price| price[:type] }
       @delivery_types
     end
 
-    # ex) item.price_stream #=> 1980
     def method_missing(method)
       if method.to_s =~ /^price_(\w+)$/
         array = deliveries.select{ |hash| hash[:type] == $1 }

data/lib/dmm/result.rb

@@ -3,22 +3,31 @@ require 'dmm/item'
 
 module Dmm
   class Result < Dmm::Base
+
+    # Returns a count of result data
+    #
     # @return [Integer]
     def result_count
       @attrs[:result_count].to_i
     end
 
+    # Returns a count of total data
+    #
     # @return [Integer]
     def total_count
       @attrs[:total_count].to_i
     end
 
+    # Returns a position of first item
+    #
     # @return [Integer]
     def first_position
       @attrs[:first_position].to_i
     end
 
-    # @return [Array]
+    # Returns a array containing Dmm::Item object
+    #
+    # @return [Array<Dmm::Item>]
     def items
       return [] unless @attrs[:items]
       item_list = @attrs[:items][:item]

data/lib/dmm/version.rb

@@ -1,3 +1,3 @@
 module Dmm
-  VERSION = "0.0.2.1"
+  VERSION = "0.0.3"
 end

data/spec/dmm/client_spec.rb

@@ -37,7 +37,7 @@ describe Dmm::Client do
 
     share_examples_for '#error_message with wrong api_id' do
       it 'should equal "LoginError: No existing account (login)"' do
-        res = subject.get('/', subject.send(:params))
+        res = Hash.from_xml(subject.get('/', subject.send(:params)))
         subject.send(:error_message, res).should eq 'LoginError: No existing account (login)'
       end
     end
@@ -63,7 +63,7 @@ describe Dmm::Client do
 
       describe '#error_message' do
         it 'should equal "RequestError: Parameter not found (affiliate_id)"' do
-          res = subject.get('/', subject.send(:params))
+          res = Hash.from_xml(subject.get('/', subject.send(:params)))
           subject.send(:error_message, res).should eq 'RequestError: Parameter not found (affiliate_id)'
         end
       end

data/spec/spec_helper.rb

@@ -1,3 +1,9 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec'
+end
+
 require 'bundler/setup'
 require 'dmm'
 require 'config/config'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dmm
 version: !ruby/object:Gem::Version
-  version: 0.0.2.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-17 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby wrapper for DMM Web Service API ver2
 email:
 - sugaishun@gmail.com
@@ -90,6 +106,7 @@ files:
 - Rakefile
 - dmm.gemspec
 - lib/dmm.rb
+- lib/dmm/api/items.rb
 - lib/dmm/base.rb
 - lib/dmm/client.rb
 - lib/dmm/core_ext/hash.rb
@@ -129,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for DMM Web Service API ver2