syoboi_calendar 0.1.3 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 868119fd5a5b282c5db313b144f77997d4671e15
+  data.tar.gz: fcab1aa760c3bdbc41d69fce7020d85f7e300176
+SHA512:
+  metadata.gz: bc6f29de1b9c57666a79f4cbc841919809c376a8afca22dd922d95ccc2f28bfda0b03a18a01fcca2321404531ad1ae52d59b7ee057c552bf1c46e1a36fed0e9b
+  data.tar.gz: 68755cfc0efbac89a202612f044c187aba095c1b8d2da8a46a3273438a298b46438e2f41f81be0abb556f3443859f3725cbe2a94d160f91d0fc7b9cdb1575495

data/.travis.yml

@@ -1,4 +1,8 @@
+branches:
+  only:
+    - master
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.2.0
+* Remake SyoboiCalendar::Client from scratch
+* Support GET /db.php API

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Ryo NAKAMURA
+Copyright (c) 2014 Ryo NAKAMURA
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,32 +1,99 @@
 # SyoboiCalendar
-
-Simple gem for [SyoboiCalendar](http://cal.syoboi.jp/) to search Japanese anime lineup
+Search Japanese anime from [SyoboiCalendar](http://cal.syoboi.jp/).
 
 ## Installation
-
-```
-$ gem install syoboi_calendar
+```ruby
+# Gemfile
+gem "syoboi_calendar"
 ```
 
 ## Usage
+```ruby
+require "syoboi_calendar"
 
+client = SyoboiCalendar::Client
+client.channels #=> [...]
+client.programs #=> [...]
+client.titles   #=> [...]
 ```
-require "syoboi_calendar"
-require "date"
 
-client = SyoboiCalendar.new(
-  :user => "r7kamura",
-  :pass => "********"
-)
-programs = client.search(
-  :first => true,
-  :range => Date.today .. Date.today + 7
-)
+## API
+Supported API request examples:
 
-p programs[0].name         #=> "さんかれあ #1 私が…ゾンビに…なったら"
-p programs[0].start_time   #=> 2012-04-06 02:50:00 +0900
-p programs[0].channel_name #=> "TBS"
 ```
+GET http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles
+GET http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&ChID=:channelID
+GET http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&Count=:count
+GET http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&PID=:id
+GET http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&PID=:id
+GET http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&Range=-:playedTo
+GET http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&Range=:playedFrom-
+GET http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&Range=:playedFrom-:playedTo
+GET http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&StTime=-:startedTo
+GET http://cal.syoboi.jp/db.php?Command=TitleLookup
+GET http://cal.syoboi.jp/db.php?Command=TitleLookup&LastUpdate=-:updatedTo&TID=*
+GET http://cal.syoboi.jp/db.php?Command=TitleLookup&LastUpdate=:updatedFrom-&TID=*
+GET http://cal.syoboi.jp/db.php?Command=TitleLookup&LastUpdate=:updatedFrom-:updatedTo&TID=*
+GET http://cal.syoboi.jp/db.php?Command=TitleLookup&TID=:id
+GET http://cal.syoboi.jp/db.php?Command=ChLookup
+GET http://cal.syoboi.jp/db.php?Command=ChLookup&ChID=:id
+GET http://cal.syoboi.jp/db.php?Command=ChLookup&LastUpdate=:updatedFrom-:updatedTo
+GET http://cal.syoboi.jp/db.php?Command=ChLookup&LastUpdate=:updatedFrom-
+GET http://cal.syoboi.jp/db.php?Command=ChLookup&LastUpdate=-:updatedTo
+```
+
+## Interface
+SyoboiCalender::Client has `#channels`, `#titles`, `#programs` methods.
 
-## Requirement
-* Ruby >= 1.9.2
+```
+SyoboiCalendar::Client
+  #channels
+    with options {}
+      requests to http://cal.syoboi.jp/db.php?Command=ChLookup
+    with options {:channel_id=>1}
+      requests to http://cal.syoboi.jp/db.php?ChID=1&Command=ChLookup
+    with options {:updated_from=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ChLookup&LastUpdate=20000101_000000-
+    with options {:updated_to=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ChLookup&LastUpdate=-20000101_000000
+    with options {:updated_from=>2000-01-01 00:00:00 UTC, :updated_to=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ChLookup&LastUpdate=20000101_000000-20000101_000000
+  #titles
+    with options {}
+      requests to http://cal.syoboi.jp/db.php?Command=TitleLookup
+    with options {:title_id=>1}
+      requests to http://cal.syoboi.jp/db.php?Command=TitleLookup&TID=1
+    with options {:updated_from=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=TitleLookup&LastUpdate=20000101_000000-
+    with options {:updated_to=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=TitleLookup&LastUpdate=-20000101_000000
+    with options {:updated_from=>2000-01-01 00:00:00 UTC, :updated_to=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=TitleLookup&LastUpdate=20000101_000000-20000101_000000
+  #programs
+    with options {}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles
+    with options {:program_id=>1}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&PID=1
+    with options {:program_id=>1, :channel_id=>2}
+      requests to http://cal.syoboi.jp/db.php?ChID=2&Command=ProgLookup&JOIN=SubTitles&PID=1
+    with options {:count=>1}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&Count=1&JOIN=SubTitles
+    with options {:updated_from=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&LastUpdate=20000101_000000-
+    with options {:updated_to=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&LastUpdate=-20000101_000000
+    with options {:updated_from=>2000-01-01 00:00:00 UTC, :updated_to=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&LastUpdate=20000101_000000-20000101_000000
+    with options {:started_from=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&StTime=20000101_000000-
+    with options {:started_to=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&StTime=-20000101_000000
+    with options {:started_from=>2000-01-01 00:00:00 UTC, :started_to=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&StTime=20000101_000000-20000101_000000
+    with options {:played_from=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&Range=20000101_000000-
+    with options {:played_to=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&Range=-20000101_000000
+    with options {:played_from=>2000-01-01 00:00:00 UTC, :played_to=>2000-01-01 00:00:00 UTC}
+      requests to http://cal.syoboi.jp/db.php?Command=ProgLookup&JOIN=SubTitles&Range=20000101_000000-20000101_000000
+```

data/Rakefile

@@ -1,26 +1,5 @@
-#!/usr/bin/env rake
-
 require "bundler/gem_tasks"
-
-begin
-  require "bundler"
-rescue LoadError
-  $stderr.puts e.message
-  $stderr.puts "Run `gem install bundler` to install bundler"
-  exit e.status_code
-end
-
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-require "rspec/core"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+task default: :spec

data/lib/syoboi_calendar/client.rb

@@ -1,99 +1,45 @@
-class SyoboiCalendar
-  module Client
-    # user and pass are optional to search with user's channel setting
-    def initialize(opts = {})
-      @agent = Agent.new(:user => opts[:user], :pass => opts[:pass])
+module SyoboiCalendar
+  class Client
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
     end
 
-    def login?
-      @agent.login?
+    def channels(options = {})
+      get(Queries::Channel, options)
     end
 
-    # search programs
-    def search(args)
-      query = create_search_query(args)
-      page  = @agent.search(query)
+    def programs(options = {})
+      get(Queries::Program, options)
+    end
 
-      args[:mode] == :title ?
-        extract_titles(page) :
-        extract_programs(page)
+    def titles(options = {})
+      get(Queries::Title, options)
     end
 
     private
 
-    # return Array of #<SyoboiCalendar::Program> by #<Mechanize::Page>
-    def extract_programs(page, opts = {})
-      page.search(".tframe tr").map do |tr|
-        args = {}
-
-        tr.search("td:nth-child(2) a").each do |a|
-          if match = a.attributes["href"].value.match(%r|/tid/(\d+)/time#(\d+)$|)
-            args[:tid]  = match[1]
-            args[:pid]  = match[2]
-            args[:name] = a.text
-          end
-        end
-
-        tr.search("td:nth-child(3)").each do |td|
-          args[:channel_name] = td.text
-        end
-
-        if args.has_key?(:tid)
-          Program.new(args)
-        else
-          nil
-        end
-      end.compact
+    def get(query_class, options = {})
+      connection.get(path, query_class.new(options).to_hash)
     end
 
-    # return Array of #<SyoboiCalendar::Title> by #<Mechanize::Page>
-    def extract_titles(page, opts = {})
-      page.search(".tframe tr").map do |tr|
-        args = {}
-
-        tr.search("td:nth-child(1) a").each do |a|
-          if match = a.attributes["href"].value.match(%r|/tid/(\d+)$|)
-            args[:tid]  = match[1]
-            args[:name] = a.text
-          end
-        end
-
-        if args.has_key?(:tid)
-          Title.new(args)
-        else
-          nil
-        end
-      end.compact
+    def connection
+      @connection ||= Faraday.new(url: url) do |connection|
+        connection.adapter :net_http
+      end
     end
 
-    # create hash for search query
-    def create_search_query(opts)
-      opts[:range] &&= canonicalize_range(opts[:range])
+    def url
+      "http://#{host}/"
+    end
 
-      {
-        :sd  => { nil => 2, :program => 2, :title => 0 }[opts[:mode]],
-        :r   => { nil => 0, :all => 0, :past => 1, :future => 2}[opts[:range]] || 3,
-        :rd  => opts[:range],
-        :kw  => opts[:keyword],
-        :ch  => opts[:channel],
-        :st  => opts[:subtitle],
-        :cm  => opts[:comment],
-        :uuc => opts[:uuc] || 1,     # use user's channel setting
-        :v   => opts[:v] || 0,       # list view
-        :pfn => opts[:first] && 2,   # first episode
-        :pfl => opts[:final] && 4,   # final episode
-        :pfs => opts[:special] && 1, # special program
-      }.select { |k, v| v }
+    def host
+      "cal.syoboi.jp"
     end
 
-    def canonicalize_range(range)
-      if range.kind_of?(Range)
-        [range.first, range.last].map { |date|
-          date.strftime("%Y/%m/%d")
-        }.join("-")
-      else
-        range
-      end
+    def path
+      "/db.php"
     end
   end
 end

data/lib/syoboi_calendar/queries/base.rb

@@ -0,0 +1,77 @@
+module SyoboiCalendar
+  module Queries
+    class Base
+      class << self
+        def property(*properties)
+          self.properties += properties
+        end
+
+        def option(*options)
+          options.each do |option|
+            define_method(option) do
+              self.options[option]
+            end
+          end
+        end
+
+        def time_option(*names)
+          names.each do |name|
+            define_method("has_#{name}_time?") do
+              !!(send("#{name}_from") || send("#{name}_to"))
+            end
+
+            define_method("formatted_#{name}_from") do
+              send("#{name}_from").try(:strftime, "%Y%m%d_%H%M%S")
+            end
+
+            define_method("formatted_#{name}_to") do
+              send("#{name}_to").try(:strftime, "%Y%m%d_%H%M%S")
+            end
+          end
+        end
+      end
+
+      class_attribute :properties
+
+      self.properties = []
+
+      option(
+        :updated_from,
+        :updated_to,
+      )
+
+      time_option(
+        :updated,
+      )
+
+      property(
+        :Command,
+        :LastUpdate,
+      )
+
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def to_hash
+        to_hash_with_nil_value.reject {|key, value| value.nil? }
+      end
+
+      def to_hash_with_nil_value
+        properties.inject({}) do |hash, property|
+          hash.merge(property => send(property.to_s.underscore))
+        end
+      end
+
+      def properties
+        self.class.properties
+      end
+
+      def last_update
+        "#{formatted_updated_from}-#{formatted_updated_to}" if has_updated_time?
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/queries/channel.rb

@@ -0,0 +1,13 @@
+module SyoboiCalendar
+  module Queries
+    class Channel < Base
+      include ChannelIdQueriable
+
+      private
+
+      def command
+        "ChLookup"
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/queries/channel_id_queriable.rb

@@ -0,0 +1,15 @@
+module SyoboiCalendar
+  module Queries
+    module ChannelIdQueriable
+      extend ActiveSupport::Concern
+
+      included do
+        option :channel_id
+
+        property :ChID
+
+        alias ch_id channel_id
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/queries/program.rb

@@ -0,0 +1,49 @@
+module SyoboiCalendar
+  module Queries
+    class Program < Base
+      include ChannelIdQueriable
+
+      option(
+        :count,
+        :program_id,
+        :played_from,
+        :played_to,
+        :started_from,
+        :started_to,
+      )
+
+      time_option(
+        :played,
+        :started,
+      )
+
+      property(
+        :Count,
+        :JOIN,
+        :PID,
+        :Range,
+        :StTime,
+      )
+
+      alias pid program_id
+
+      private
+
+      def command
+        "ProgLookup"
+      end
+
+      def join
+        "SubTitles"
+      end
+
+      def range
+        "#{formatted_played_from}-#{formatted_played_to}" if has_played_time?
+      end
+
+      def st_time
+        "#{formatted_started_from}-#{formatted_started_to}" if has_started_time?
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/queries/title.rb

@@ -0,0 +1,17 @@
+module SyoboiCalendar
+  module Queries
+    class Title < Base
+      option :title_id
+
+      property :TID
+
+      alias tid title_id
+
+      private
+
+      def command
+        "TitleLookup"
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/version.rb

@@ -1,3 +1,3 @@
-class SyoboiCalendar
-  VERSION = "0.1.3"
+module SyoboiCalendar
+  VERSION = "0.2.0"
 end

data/lib/syoboi_calendar.rb

@@ -1,13 +1,12 @@
-# gems
-require "mechanize"
+require "active_support/concern"
+require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/string/inflections"
+require "faraday"
 
-# libraries
-require "syoboi_calendar/version"
-require "syoboi_calendar/agent"
-require "syoboi_calendar/title"
-require "syoboi_calendar/program"
 require "syoboi_calendar/client"
-
-class SyoboiCalendar
-  include SyoboiCalendar::Client
-end
+require "syoboi_calendar/queries/base"
+require "syoboi_calendar/queries/channel_id_queriable"
+require "syoboi_calendar/queries/channel"
+require "syoboi_calendar/queries/program"
+require "syoboi_calendar/queries/title"

data/spec/spec_helper.rb

@@ -1,29 +1,11 @@
-$LOAD_PATH.unshift File.expand_path("../", __FILE__)
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-
 require "simplecov"
 SimpleCov.start
 
 require "syoboi_calendar"
 require "webmock/rspec"
 
-WebMock.allow_net_connect!
-
-module SyoboiCalendar::Fixture
-  extend self
-
-  FIXTURE_DIR = File.expand_path("../fixtures", __FILE__)
-
-  private
-
-  def method_missing(method_name, *args)
-    cache[method_name] ||= begin
-      path = "#{FIXTURE_DIR}/#{method_name}"
-      File.exist?(path) ? cache[method_name] = File.read(path) : nil
-    end
-  end
-
-  def cache
-    @cache ||= {}
-  end
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
 end