butter_sand 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - rbx-18mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem 'rake'
+gem 'coveralls', :require => false
 # Specify your gem's dependencies in butter_sand.gemspec
 gemspec

data/README.md

@@ -1,5 +1,11 @@
 # ButterSand
 
+[![Gem Version](https://badge.fury.io/rb/butter_sand.png)](https://rubygems.org/gems/butter_sand)
+[![Build Status](https://travis-ci.org/shunsugai/butter_sand.png?branch=master)](https://travis-ci.org/shunsugai/butter_sand)
+[![Coverage Status](https://coveralls.io/repos/shunsugai/butter_sand/badge.png?branch=master)](https://coveralls.io/r/shunsugai/butter_sand?branch=master)
+[![Code Climate](https://codeclimate.com/github/shunsugai/butter_sand.png)](https://codeclimate.com/github/shunsugai/butter_sand)
+[![Dependency Status](https://gemnasium.com/shunsugai/butter_sand.png)](https://gemnasium.com/shunsugai/butter_sand)
+
 六花亭さんの催事情報ページの内容を取得するためのRubyラッパーです
 
 ## インストール方法

data/lib/butter_sand/api/events.rb

@@ -7,26 +7,39 @@ module ButterSand
     module Events
       PATH_SAIJI = '/contents/shop/saiji/'
 
-      # @return [Array<ButterSand::Event>]
+      # Returns list of all event information listed on the page. When there is no event information to be held, returns empty array.
+      #
+      # @return [Array<ButterSand::Event>] event information listed on the page
       def all
         ButterSand::Parser.to_array(get(PATH_SAIJI)).map {|event| ButterSand::Event.new(event)}
       end
 
+      # Returns list of event information being held. When there is no corresponding data, returns empty array.
+      #
+      # @return [Array<ButterSand::Event>] event information being held
       def on_sale
-        all.select {|event| (event.starts..event.ends) === Date.today}
+        all.select {|event| (event.starts..event.ends) === (@date_for_test || Date.today)}
       end
 
-      # @return [Array<ButterSand::Event>]
+      # Returns list of event information that starts today. When there is no corresponding data, returns empty array.
+      #
+      # @return [Array<ButterSand::Event>] event information that starts today
       def starts_today
-        all.select {|event| event.starts == Date.today}
+        all.select {|event| event.starts == (@date_for_test || Date.today)}
       end
 
-      # @return [Array<ButterSand::Event>]
+      # Returns list of event information that ends today. When there is no corresponding data, returns empty array.
+      #
+      # @return [Array<ButterSand::Event>] event information that ends today
       def ends_today
-        all.select {|event| event.ends == Date.today}
+        all.select {|event| event.ends == (@date_for_test || Date.today)}
       end
 
-      # @return [Array<ButterSand::Event>]
+      # Returns list of event information selected with given prefecture name. When there is no corresponding data, returns empty array.
+      #
+      # @raise [ArgumentError] Error raised when supplied prefecture name is not valid
+      # @param name [String] prefecture name
+      # @return [Array<ButterSand::Event>] event information selected with given prefecture name
       def find_by_prefecture(name)
         raise ArgumentError , 'Illegal argument' unless name.kind_of? String
         all.select {|event| event.prefecture == name}

data/lib/butter_sand/client.rb

@@ -23,7 +23,7 @@ module ButterSand
     end
 
     def connection
-      @connection ||= Faraday.new ROOT_URL, ssl: {verify: false} do |conn|
+      @connection ||= Faraday.new ROOT_URL, :ssl => {:verify => false} do |conn|
         conn.use Faraday::Response::RaiseButterSandError
         conn.use Faraday::Adapter::NetHttp
       end

data/lib/butter_sand/parser.rb

@@ -6,34 +6,49 @@ require 'nokogiri'
 module ButterSand
   class Parser
     class << self
+
+      KEY_DATE_INFO  = 0
+      KEY_PREFECTURE = 1
+      KEY_SHOP_NAME  = 2
+      KEY_PHONE_NUM  = 3
+
+      KEY_DATE_STARTS = 0
+      KEY_DATE_ENDS   = 1
+
       # @return [Array<Hash>]
       def to_array(body)
-        shops = []
-        raw_events(Nokogiri::HTML(body)).each do |elem|
-          str_elems = elem.split(/\n\s+/)
-
-          next if str_elems.length < 4
-          next unless str_elems[3].strip.phone_number?
-          begin
-            dates = str_elems[0].date_to_ary
-          rescue ArgumentError => e
-            print e.message, "\n"
-            next
-          end
-
-          shops << {
-            shop:       str_elems[2],
-            prefecture: str_elems[1],
-            phone:      str_elems[3].strip,
-            starts:     dates[0],
-            ends:       dates[1]
-          }
-        end
-        shops
+        valid_infos = raw_events(Nokogiri::HTML(body)).select { |elem| is_valid_data? elem }
+        valid_infos.map { |elem| shop_data_hash(elem.split(/\n\s+/)) }
       end
 
       private
 
+      # @retrn [Hash]
+      def shop_data_hash(list)
+        dates = list[KEY_DATE_INFO].date_to_ary
+        {
+          :shop       => list[KEY_SHOP_NAME],
+          :prefecture => list[KEY_PREFECTURE],
+          :phone      => list[KEY_PHONE_NUM].strip,
+          :starts     => dates[KEY_DATE_STARTS],
+          :ends       => dates[KEY_DATE_ENDS]
+        }
+      end
+
+      # @return [Boolean]
+      def is_valid_data?(raw_data)
+        str_elems = raw_data.split(/\n\s+/)
+        return false if str_elems.length < 4
+        return false unless str_elems[KEY_PHONE_NUM].strip.phone_number?
+        begin
+          dates = str_elems[KEY_DATE_INFO].date_to_ary
+        rescue ArgumentError => e
+          print e.message, "\n"
+          return false
+        end
+        true
+      end
+
       # @return [Array<String>]
       def raw_events(body)
         each_state = state_names.map {|state| body.css(state).map(&:text).remove_at(0)}

data/lib/butter_sand/version.rb

@@ -1,3 +1,3 @@
 module ButterSand
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/butter_sand/api/events_spec.rb

@@ -13,6 +13,64 @@ describe ButterSand::API::Events do
     it { should have(5).items }
   end
 
+  describe 'on_sale' do
+    before do
+      @butter_sand = ButterSand::Client.new
+      @butter_sand.instance_eval { @date_for_test = Date.parse('2013-03-14') }
+    end
+
+    subject { @butter_sand.on_sale }
+    it { should have(1).item }
+  end
+
+  describe 'starts_today' do
+    before do
+      @butter_sand = ButterSand::Client.new
+    end
+
+    subject { @butter_sand.starts_today }
+
+    context 'with no corresponding event' do
+      before do
+        @butter_sand.instance_eval { @date_for_test = Date.parse('2012-12-31') }
+      end
+
+      it { should have(0).item }
+    end
+
+    context 'with some corresponding events' do
+      before do
+        @butter_sand.instance_eval { @date_for_test = Date.parse('2013-01-15') }
+      end
+
+      it { should have(1).item }
+    end
+  end
+
+  describe 'ends_today' do
+    before do
+      @butter_sand = ButterSand::Client.new
+    end
+
+    subject { @butter_sand.ends_today }
+
+    context 'with no corresponding event' do
+      before do
+        @butter_sand.instance_eval { @date_for_test = Date.parse('2013-01-01') }
+      end
+
+      it { should have(0).item }
+    end
+
+    context 'with some corresponding events' do
+      before do
+        @butter_sand.instance_eval { @date_for_test = Date.parse('2013-02-28') }
+      end
+
+      it { should have(1).item }
+    end
+  end
+
   describe 'find_by_prefecture' do
     it 'should have an item' do
       ButterSand.send(:find_by_prefecture, '東京').should have(1).item

data/spec/butter_sand/client_spec.rb

@@ -6,12 +6,24 @@ describe ButterSand::Client do
 
   describe 'get' do
     context '400' do
-      before do
-        stub_request(:get, url).to_return(:status => 400, :body => {'error' => 'Bad Request'})
+      context 'with no error message' do
+        before do
+          stub_request(:get, url).to_return(:status => 400, :body => {'error' => ''})
+        end
+
+        it 'should raise ButterSand::BadRequest' do
+          lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::BadRequest, 'GET https://www.rokkatei-eshop.com/contents/shop/saiji/: 400'
+        end
       end
 
-      it 'should raise ButterSand::BadRequest' do
-        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::BadRequest
+      context 'with error message' do
+        before do
+          stub_request(:get, url).to_return(:status => 400, :body => {'error' => 'BadRequest'})
+        end
+
+        it 'should raise ButterSand::BadRequest' do
+          lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::BadRequest, 'BadRequest'
+        end
       end
     end
 
@@ -21,7 +33,7 @@ describe ButterSand::Client do
       end
 
       it 'should raise ButterSand::Unauthorized' do
-        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::Unauthorized
+        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::Unauthorized, 'Unauthorized'
       end
     end
 
@@ -31,7 +43,7 @@ describe ButterSand::Client do
       end
 
       it 'should raise ButterSand::Unauthorized' do
-        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::Forbidden
+        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::Forbidden, 'Forbidden'
       end
     end
 
@@ -41,7 +53,7 @@ describe ButterSand::Client do
       end
 
       it 'should raise ButterSand::NotFound' do
-        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::NotFound
+        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::NotFound, 'Not Found'
       end
     end
 
@@ -51,7 +63,7 @@ describe ButterSand::Client do
       end
 
       it 'should raise ButterSand::NotAcceptable' do
-        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::NotAcceptable
+        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::NotAcceptable, 'Not Acceptable'
       end
     end
 
@@ -61,7 +73,7 @@ describe ButterSand::Client do
       end
 
       it 'should raise ButterSand::InternalServerError' do
-        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::InternalServerError
+        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::InternalServerError, 'Internal Server Error'
       end
     end
 
@@ -71,7 +83,7 @@ describe ButterSand::Client do
       end
 
       it 'should raise ButterSand::ServiceUnavailable' do
-        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::ServiceUnavailable
+        lambda{ ButterSand.get(path_saiji) }.should raise_error ButterSand::ServiceUnavailable, 'Internal Server Error'
       end
     end
   end

data/spec/butter_sand/parser_spec.rb

@@ -7,8 +7,7 @@ describe ButterSand::Parser do
 
   context 'with some events' do
     before do
-      stub_request(:get, 'https://www.rokkatei-eshop.com/contents/shop/saiji/')
-      .to_return(:status => 200, :body => fixture('marusei.html'))
+      stub_request(:get, 'https://www.rokkatei-eshop.com/contents/shop/saiji/').to_return(:status => 200, :body => fixture('marusei.html'))
       @response = ButterSand.get(path_saiji)
       @response_array = ButterSand::Parser.to_array(@response)
     end
@@ -23,7 +22,7 @@ describe ButterSand::Parser do
       end
 
       it 'includes Hash' do
-        @response_array.sample.should be_kind_of Hash
+        @response_array.first.should be_kind_of Hash
       end
 
       it "first item's shop name should be 'うすい百貨店'" do
@@ -50,8 +49,7 @@ describe ButterSand::Parser do
 
   context 'with no event' do
     before do
-      stub_request(:get, 'https://www.rokkatei-eshop.com/contents/shop/saiji/')
-      .to_return(:status => 200, :body => fixture('marusei_no_event.html'))
+      stub_request(:get, 'https://www.rokkatei-eshop.com/contents/shop/saiji/').to_return(:status => 200, :body => fixture('marusei_no_event.html'))
       @response = ButterSand.get(path_saiji)
       @response_array = ButterSand::Parser.to_array(@response)
     end

data/spec/spec_helper.rb

@@ -8,6 +8,9 @@ require 'bundler/setup'
 require 'butter_sand'
 require 'faraday/response/raise_butter_sand_error'
 require 'webmock/rspec'
+require 'date'
+require 'coveralls'
+Coveralls.wear!
 
 RSpec.configure do |config|
   config.order = 'random'
@@ -19,4 +22,4 @@ end
 
 def fixture(file)
   File.new(fixture_path + '/' + file)
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: butter_sand
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2013-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -146,8 +146,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md