syoboi_calendar 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c784bb59897bd758d21932242d40099f76a6620d
-  data.tar.gz: 9670e8cb32bce32fba0a8be526fe8c570bcf97b0
+  metadata.gz: 49970d4dc6d0995fdceb42f41110ceb6377cef6c
+  data.tar.gz: 5a5e061756c0a3d599d4134998d7104231f59cb2
 SHA512:
-  metadata.gz: 37c20a5b6d89934ae1ad18741d07e30052736f34beb257a595375ff9d39a952462c74c59ba2d217787c163877e8ead5294e9a489a44f7b714243113676ffb20e
-  data.tar.gz: f2cdf3fe11d729a1d657b1e6c08e3cf9714b92e5d32790c02ae97a5656bcd3fa89377aac2aef290d440fbe5c74e9e77328944f981915518e94dcdfdc38988f0b
+  metadata.gz: 5b65a62a6b9d37cdc00f932f1820b1c62d97b43a44ddd6bb47733798fa54a15548a1efda8f1d992b10991a5e2ef02e0471398f8cfa320e001c5fbd813569b474
+  data.tar.gz: 9986bd57b3ab9e4801df776e3a1656be2ac2bfa0e958caf5b7c543c8245ae571c0aa3816e9f3610b7cbc0d0ceaea53d1bf6abba23261b677f94aa168968d5535

data/.travis.yml

@@ -5,7 +5,6 @@ language: ruby
 rvm:
 - 1.9.3
 - 2.0.0
-- 2.1.0
 env:
   global:
     secure: jireAT1B+27QH2v5EUjdIu9/ELwA+fj67PtCFiw7nSvzzQV4sC94/otyrPlNqsLKijWk+fQw5XcW9HvSTXvCgGguQn5AGW+MjPu9AbuZAbWf6ayZFHIgaPxmBzFYZaC2yK9XL0kVMG/UdhDM9Vy9auf1kDPphMhwAGZ2yjuSBj0=

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.3.1
+* Client#programs supports `:include` option for eage-loading related resources
+
 ## 0.3.0
 * SyoboiCalendar::Client returns an Array of resources
 

data/README.md

@@ -13,9 +13,9 @@ gem "syoboi_calendar"
 require "syoboi_calendar"
 
 client = SyoboiCalendar::Client.new
-client.channels #=> a Hashie::Mash instance
-client.programs #=> a Hashie::Mash instance
-client.titles   #=> a Hashie::Mash instance
+client.channels #=> an Array of SyoboiCalendar::Resources::Channel
+client.programs #=> an Array of SyoboiCalendar::Resources::Program
+client.titles   #=> an Array of SyoboiCalendar::Resources::Title
 ```
 
 ## API
@@ -73,3 +73,60 @@ SyoboiCalendar::Client
     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
 ```
+
+## Resources
+SyoboiCalendar::Client returns an Array of resources.
+
+### SyoboiCalendar::Resources::Channel
+* comment
+* epg_url
+* group_id
+* id
+* iepg_name
+* name
+* number
+* url
+
+
+### SyoboiCalendar::Resources::Title
+* category_id
+* comment
+* first_channel
+* first_end_month
+* first_end_year
+* first_month
+* first_year
+* keywords
+* short_title
+* sub_titles
+* id
+* name
+* english_name
+* flag
+* kana
+* point
+* rank
+
+### SyoboiCalendar::Resources::Program
+* channel_id
+* comment
+* count
+* deleted?
+* finished_at
+* flag
+* id
+* revision
+* started_at
+* sub_title
+* title_id
+* updated_at
+* warn
+
+## Eager Loading
+Client#programs supports `:include` option for eage-loading related resources.
+
+```ruby
+programs = client.programs(include: [:channel, :title])
+programs.first.channel #=> SyoboiCalendar::Resources::Channel
+programs.first.title   #=> SyoboiCalendar::Resources::title
+```

data/lib/syoboi_calendar/client.rb

@@ -1,43 +1,15 @@
 module SyoboiCalendar
   class Client
     def channels(options = {})
-      process(
-        QueryBuilders::Channel,
-        Parsers::Channel,
-        options,
-      )
+      Processors::Channel.process(options)
     end
 
     def programs(options = {})
-      process(
-        QueryBuilders::Program,
-        Parsers::Program,
-        options,
-      )
+      Processors::Program.process(options)
     end
 
     def titles(options = {})
-      process(
-        QueryBuilders::Title,
-        Parsers::Title,
-        options,
-      )
-    end
-
-    private
-
-    def connector
-      @connector ||= Connector.new
-    end
-
-    def get(query)
-      connector.get(query).body
-    end
-
-    def process(builder, parser, options)
-      query = builder.build(options)
-      response = get(query)
-      parser.parse(response)
+      Processors::Title.process(options)
     end
   end
 end

data/lib/syoboi_calendar/processors/base.rb

@@ -0,0 +1,43 @@
+module SyoboiCalendar
+  module Processors
+    class Base
+      class << self
+        def process(*args)
+          new(*args).process
+        end
+      end
+
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def process
+        resources
+      end
+
+      private
+
+      def resources
+        @resources ||= begin
+          query = query_builder.build(options)
+          response = get(query)
+          parser.parse(response)
+        end
+      end
+
+      def connector
+        @connector ||= Connector.new
+      end
+
+      def get(query)
+        connector.get(query).body
+      end
+
+      def includes
+        Array.wrap(options[:includes])
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/processors/channel.rb

@@ -0,0 +1,15 @@
+module SyoboiCalendar
+  module Processors
+    class Channel < Base
+      private
+
+      def query_builder
+        QueryBuilders::Channel
+      end
+
+      def parser
+        Parsers::Channel
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/processors/program.rb

@@ -0,0 +1,81 @@
+module SyoboiCalendar
+  module Processors
+    class Program < Base
+      def process
+        include_channel if specified_to_include_channel?
+        include_title if specified_to_include_title?
+        resources
+      end
+
+      private
+
+      def query_builder
+        QueryBuilders::Program
+      end
+
+      def parser
+        Parsers::Program
+      end
+
+      def titles_indexed_by_id
+        @titles_indexed_by_id ||= titles.index_by(&:id)
+      end
+
+      def titles
+        Parsers::Title.parse(titles_response)
+      end
+
+      def titles_response
+        connector.get(titles_query).body
+      end
+
+      def titles_query
+        QueryBuilders::Title.build(title_id: title_ids.join(","))
+      end
+
+      def title_ids
+        resources.map(&:title_id)
+      end
+
+      def specified_to_include_title?
+        includes.include?(:title)
+      end
+
+      def specified_to_include_channel?
+        includes.include?(:channel)
+      end
+
+      def include_title
+        resources.each do |program|
+          program.title = titles_indexed_by_id[program.title_id]
+        end
+      end
+
+      def channels_indexed_by_id
+        @channels_indexed_by_id ||= channels.index_by(&:id)
+      end
+
+      def channels
+        Parsers::Channel.parse(channels_response)
+      end
+
+      def channels_response
+        connector.get(channels_query).body
+      end
+
+      def channels_query
+        QueryBuilders::Channel.build(channel_id: channel_ids.join(","))
+      end
+
+      def channel_ids
+        resources.map(&:channel_id)
+      end
+
+      def include_channel
+        resources.each do |program|
+          program.channel = channels_indexed_by_id[program.channel_id]
+        end
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/processors/title.rb

@@ -0,0 +1,15 @@
+module SyoboiCalendar
+  module Processors
+    class Title < Base
+      private
+
+      def query_builder
+        QueryBuilders::Title
+      end
+
+      def parser
+        Parsers::Title
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/query_builders/base.rb

@@ -2,8 +2,8 @@ module SyoboiCalendar
   module QueryBuilders
     class Base
       class << self
-        def build(options)
-          new(options).to_hash
+        def build(*args)
+          new(*args).to_hash
         end
 
         def property(*properties)

data/lib/syoboi_calendar/resources/program.rb

@@ -1,6 +1,8 @@
 module SyoboiCalendar
   module Resources
     class Program < Base
+      attr_accessor :channel, :title
+
       def id
         response.PID.try(:to_i)
       end

data/lib/syoboi_calendar/version.rb

@@ -1,3 +1,3 @@
 module SyoboiCalendar
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/syoboi_calendar.rb

@@ -1,6 +1,7 @@
 require "active_support/concern"
 require "active_support/core_ext/array/wrap"
 require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/enumerable"
 require "active_support/core_ext/object/try"
 require "active_support/core_ext/string/inflections"
 require "faraday"
@@ -12,6 +13,10 @@ require "syoboi_calendar/parsers/base"
 require "syoboi_calendar/parsers/channel"
 require "syoboi_calendar/parsers/program"
 require "syoboi_calendar/parsers/title"
+require "syoboi_calendar/processors/base"
+require "syoboi_calendar/processors/channel"
+require "syoboi_calendar/processors/program"
+require "syoboi_calendar/processors/title"
 require "syoboi_calendar/query_builders/base"
 require "syoboi_calendar/query_builders/channel_id_queriable"
 require "syoboi_calendar/query_builders/channel"

data/spec/syoboi_calendar/client_spec.rb

@@ -1,5 +1,5 @@
+# coding: utf-8
 require "spec_helper"
-require "active_support/core_ext/object/to_query"
 
 describe SyoboiCalendar::Client do
   before do
@@ -373,5 +373,17 @@ describe SyoboiCalendar::Client do
         programs[0].warn.should == 1
       end
     end
+
+    context "with :include option" do
+      let!(:request) do
+        stub_request(:get, //).to_rack(app)
+      end
+
+      it "eager loads related resources" do
+        programs = client.programs(includes: [:channel, :title])
+        programs[0].channel.should be_a SyoboiCalendar::Resources::Channel
+        programs[0].title.should be_a SyoboiCalendar::Resources::Title
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syoboi_calendar
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -199,6 +199,10 @@ files:
 - lib/syoboi_calendar/parsers/channel.rb
 - lib/syoboi_calendar/parsers/program.rb
 - lib/syoboi_calendar/parsers/title.rb
+- lib/syoboi_calendar/processors/base.rb
+- lib/syoboi_calendar/processors/channel.rb
+- lib/syoboi_calendar/processors/program.rb
+- lib/syoboi_calendar/processors/title.rb
 - lib/syoboi_calendar/query_builders/base.rb
 - lib/syoboi_calendar/query_builders/channel.rb
 - lib/syoboi_calendar/query_builders/channel_id_queriable.rb