syoboi_calendar 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5346554a9e8ec0c05a1a7f9b715edd122ab8cce2
-  data.tar.gz: 28c95e9429d5626c612476f9386504cadc048e96
+  metadata.gz: 8facc19f2111d8b7daa7d7baeb1893e4744b0632
+  data.tar.gz: 61e353b7d123d76c96dc948a605d2bb0b4e3a19c
 SHA512:
-  metadata.gz: 54c8869860f68a1d928a7bed7bee325c66c700da04a98088cfd24942053942b3ceac230d5d41f8f030bc7a8c8f7906b68d8140ea88963637765cb88beda1cbab
-  data.tar.gz: 7c147a0f1b67908fed9cd67ba2aab48daf161050140230e7a8f1f00d973ccd973d51450f9a0ee32f976e6b4971a46ce7c97de9ceaa99936635a1eef56f5add6d
+  metadata.gz: ff535c1524af5faa35d84d8ebf6918d3de6cfe9753743fc93ede02f187f63213c3b557ee207be4101058a414d7304a1b814a0b2a44b4c4b7175b449f2f65114f
+  data.tar.gz: 8b2efb2f7340359703684ccd38cb02cba56aae27d391f55278d3b53dfc9c0023d15e9695e49fcf0c843039754cf289e2fdf9fbfb61c3bcb3da1fd00fc07ef453

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.6.0
+
+- Support channel groups
+- Change resource attribute name from `group_id` to `channel_group_id`
+
 ## 0.5.1
 
 - Support :title_id options on list_programs method

data/README.md

@@ -41,6 +41,38 @@ require "syoboi_calendar"
 client = SyoboiCalendar::Client.new
 ```
 
+### SyoboiCalendar::Client#list_channel_groups
+
+Sends an HTTP request to `http://cal.syoboi.jp/db.php?Command=ChGroupLookup`.
+
+```ruby
+client.list_channel_groups
+```
+
+Sends an HTTP request to `http://cal.syoboi.jp/db.php?ChGID=1&Command=ChGroupLookup`.
+
+```ruby
+client.list_channel_groups(channel_group_id: 1)
+```
+
+Sends an HTTP request to `http://cal.syoboi.jp/db.php?Command=ChGroupLookup&LastUpdate=20000101_000000-`.
+
+```ruby
+client.list_channel_groups(updated_from: Time.new(2000, 1, 1))
+```
+
+Sends an HTTP request to `http://cal.syoboi.jp/db.php?Command=ChGroupLookup&LastUpdate=-20000101_000000`.
+
+```ruby
+client.list_channel_groups(updated_to: Time.new(2000, 1, 1))
+```
+
+Sends an HTTP request to `http://cal.syoboi.jp/db.php?Command=ChGroupLookup&LastUpdate=20000101_000000-20000201_000000`.
+
+```ruby
+client.list_channel_groups(updated_from: Time.new(2000, 1, 1), updated_to: Time.new(2000, 2, 1))
+```
+
 ### SyoboiCalendar::Client#list_channels
 
 Sends an HTTP request to `http://cal.syoboi.jp/db.php?Command=ChLookup`.
@@ -203,40 +235,70 @@ Sends an HTTP request to `http://cal.syoboi.jp/db.php?Command=TitleLookupp&TID=*
 client.list_titles(updated_from: Time.new(2000, 1, 1), updated_to: Time.new(2000, 2, 1))
 ```
 
-### SyoboiCalendar::Resources::ChannelResource#comment
+### SyoboiCalendar::Resources::ChannelGroupResource#comment
 
 ```ruby
-client.list_channels.first.comment
+client.list_channel_groups.to_a[5].comment
 ```
 
 <details>
 <summary>Result</summary>
 
 ```ruby
-"http://jk.nicovideo.jp/watch/jk1"
+"aa"
 ```
 
 </details>
 
-### SyoboiCalendar::Resources::ChannelResource#epg_url
+### SyoboiCalendar::Resources::ChannelGroupResource#id
 
 ```ruby
-client.list_channels.first.epg_url
+client.list_channel_groups.first.id
 ```
 
 <details>
 <summary>Result</summary>
 
 ```ruby
-"http://www2.nhk.or.jp/hensei/program/wk.cgi?tz=all&ch=21"
+1
+```
+
+</details>
+
+### SyoboiCalendar::Resources::ChannelGroupResource#name
+
+```ruby
+client.list_channel_groups.first.name
+```
+
+<details>
+<summary>Result</summary>
+
+```ruby
+"テレビ 関東"
+```
+
+</details>
+
+### SyoboiCalendar::Resources::ChannelGroupResource#order_score
+
+```ruby
+client.list_channel_groups.first.order_score
+```
+
+<details>
+<summary>Result</summary>
+
+```ruby
+1200
 ```
 
 </details>
 
-### SyoboiCalendar::Resources::ChannelResource#group_id
+### SyoboiCalendar::Resources::ChannelResource#channel_group_id
 
 ```ruby
-client.list_channels.first.group_id
+client.list_channels.first.channel_group_id
 ```
 
 <details>
@@ -248,6 +310,36 @@ client.list_channels.first.group_id
 
 </details>
 
+### SyoboiCalendar::Resources::ChannelResource#comment
+
+```ruby
+client.list_channels.first.comment
+```
+
+<details>
+<summary>Result</summary>
+
+```ruby
+"http://jk.nicovideo.jp/watch/jk1"
+```
+
+</details>
+
+### SyoboiCalendar::Resources::ChannelResource#epg_url
+
+```ruby
+client.list_channels.first.epg_url
+```
+
+<details>
+<summary>Result</summary>
+
+```ruby
+"http://www2.nhk.or.jp/hensei/program/wk.cgi?tz=all&ch=21"
+```
+
+</details>
+
 ### SyoboiCalendar::Resources::ChannelResource#id
 
 ```ruby
@@ -278,6 +370,21 @@ client.list_channels.first.iepg_name
 
 </details>
 
+### SyoboiCalendar::Resources::ChannelResource#name
+
+```ruby
+client.list_channels.first.name
+```
+
+<details>
+<summary>Result</summary>
+
+```ruby
+"NHK総合"
+```
+
+</details>
+
 ### SyoboiCalendar::Resources::ChannelResource#number
 
 ```ruby

data/lib/syoboi_calendar/client.rb

@@ -13,6 +13,13 @@ module SyoboiCalendar
       end
     end
 
+    # @return [Array<SyoboiCalendar::Resources::ChannelGroup>]
+    def list_channel_groups(options = {})
+      query = ::SyoboiCalendar::Queries::ChannelGroupQuery.new(options)
+      faraday_response = get(query.to_hash)
+      ::SyoboiCalendar::Responses::ChannelGroupsResponse.new(faraday_response)
+    end
+
     # @return [Array<SyoboiCalendar::Resources::Channel>]
     def list_channels(options = {})
       query = ::SyoboiCalendar::Queries::ChannelQuery.new(options)

data/lib/syoboi_calendar/queries/channel_group_query.rb

@@ -0,0 +1,21 @@
+module SyoboiCalendar
+  module Queries
+    class ChannelGroupQuery < BaseQuery
+      COMMAND = "ChGroupLookup"
+
+      property :ChGID
+
+      # @return [String, nil]
+      def ChGID
+        if options[:channel_group_id]
+          format_comma_separated_values(options[:channel_group_id])
+        end
+      end
+
+      # @note Override
+      def Command
+        COMMAND
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/resources/channel_group_resource.rb

@@ -0,0 +1,25 @@
+module SyoboiCalendar
+  module Resources
+    class ChannelGroupResource < BaseResource
+      # @return [String, nil]
+      def comment
+        response.ChGroupComment
+      end
+
+      # @return [Integer, nil]
+      def id
+        response.ChGID.try(:to_i)
+      end
+
+      # @return [String, nil]
+      def name
+        response.ChGroupName
+      end
+
+      # @return [Integer, nil]
+      def order_score
+        response.ChGroupOrder.try(:to_i)
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/resources/channel_resource.rb

@@ -1,6 +1,11 @@
 module SyoboiCalendar
   module Resources
     class ChannelResource < BaseResource
+      # @return [Integer, nil]
+      def channel_group_id
+        response.ChGID.try(:to_i)
+      end
+
       # @return [String, nil]
       def comment
         response.ChComment
@@ -11,11 +16,6 @@ module SyoboiCalendar
         response.ChEPGURL
       end
 
-      # @return [Integer, nil]
-      def group_id
-        response.ChGID.try(:to_i)
-      end
-
       # @return [Integer, nil]
       def id
         response.ChID.try(:to_i)

data/lib/syoboi_calendar/resources/title_resource.rb

@@ -1,6 +1,17 @@
 module SyoboiCalendar
   module Resources
     class TitleResource < BaseResource
+      # @note
+      #    0: その他
+      #    1: アニメ
+      #    2: ラジオ
+      #    3: テレビ
+      #    4: 特撮
+      #    5: アニメ関連
+      #    6: メモ
+      #    7: OVA
+      #    8: 映画
+      #   10: アニメ(終了/再放送)
       # @return [Integer, nil]
       def category_id
         response.Cat.try(:to_i)

data/lib/syoboi_calendar/responses/channel_groups_response.rb

@@ -0,0 +1,12 @@
+module SyoboiCalendar
+  module Responses
+    class ChannelGroupsResponse < BaseResponse
+      # @note Override
+      def resources
+        ::Array.wrap(faraday_response.body.ChGroupLookupResponse.ChGroupItems.ChGroupItem).map do |element|
+          ::SyoboiCalendar::Resources::ChannelGroupResource.new(element)
+        end
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/version.rb

@@ -1,3 +1,3 @@
 module SyoboiCalendar
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/lib/syoboi_calendar.rb

@@ -6,14 +6,17 @@ require "faraday_middleware"
 
 require "syoboi_calendar/client"
 require "syoboi_calendar/queries/base_query"
+require "syoboi_calendar/queries/channel_group_query"
 require "syoboi_calendar/queries/channel_query"
 require "syoboi_calendar/queries/program_query"
 require "syoboi_calendar/queries/title_query"
 require "syoboi_calendar/resources/base_resource"
+require "syoboi_calendar/resources/channel_group_resource"
 require "syoboi_calendar/resources/channel_resource"
 require "syoboi_calendar/resources/program_resource"
 require "syoboi_calendar/resources/title_resource"
 require "syoboi_calendar/responses/base_response"
+require "syoboi_calendar/responses/channel_groups_response"
 require "syoboi_calendar/responses/channels_response"
 require "syoboi_calendar/responses/programs_response"
 require "syoboi_calendar/responses/titles_response"

data/spec/syoboi_calendar/client_spec.rb

@@ -3,6 +3,28 @@ describe ::SyoboiCalendar::Client do
     described_class.new
   end
 
+  let(:dummy_channel_groups_response) do
+    <<-EOS.strip_heredoc
+      <?xml version="1.0" encoding="UTF-8"?>
+      <ChGroupLookupResponse>
+        <Result>
+          <Code>200</Code>
+          <Message>
+          </Message>
+        </Result>
+        <ChGroupItems>
+          <ChGroupItem id="3">
+            <ChGroupComment>DummyComment</ChComment>
+            <ChGID>1</ChGID>
+            <ChGroupName>DummyChannelName</ChName>
+            <Order>1000</Order>
+            <LastUpdate>2000-01-01 00:00:00</LastUpdate>
+          </ChGroupItem>
+        </ChGroupItems>
+      </ChGroupLookupResponse>
+    EOS
+  end
+
   let(:dummy_channels_response) do
     <<-EOS.strip_heredoc
       <?xml version="1.0" encoding="UTF-8"?>
@@ -120,6 +142,74 @@ describe ::SyoboiCalendar::Client do
     request
   end
 
+  describe "#list_channel_groups" do
+    subject do
+      client.list_channel_groups(options)
+    end
+
+    let(:options) do
+      {}
+    end
+
+    [
+      {
+        options: {},
+        query: {
+          Command: "ChGroupLookup",
+        },
+      },
+      {
+        options: {
+          channel_group_id: 1,
+        },
+        query: {
+          Command: "ChGroupLookup",
+          ChGID: 1,
+        },
+      },
+      {
+        options: {
+          updated_from: ::Time.new(2000, 1, 1),
+        },
+        query: {
+          Command: "ChGroupLookup",
+          LastUpdate: "20000101_000000-",
+        },
+      },
+      {
+        options: {
+          updated_to: ::Time.new(2000, 1, 1),
+        },
+        query: {
+          Command: "ChGroupLookup",
+          LastUpdate: "-20000101_000000",
+        },
+      },
+      {
+        options: {
+          updated_from: ::Time.new(2000, 1, 1),
+          updated_to: ::Time.new(2000, 1, 1),
+        },
+        query: {
+          Command: "ChGroupLookup",
+          LastUpdate: "20000101_000000-20000101_000000",
+        },
+      },
+    ].each do |example|
+      context "with options #{example[:options].inspect}" do
+        let(:options) do
+          example[:options]
+        end
+
+        it "sends an HTTP request to http://cal.syoboi.jp/db.php?#{example[:query].to_query}" do
+          stub = stub_request(:get, "http://cal.syoboi.jp/db.php?#{example[:query].to_query}")
+          subject
+          expect(stub).to have_been_made
+        end
+      end
+    end
+  end
+
   describe "#list_channels" do
     subject do
       client.list_channels(options)
@@ -194,9 +284,9 @@ describe ::SyoboiCalendar::Client do
 
       it "returns channels" do
         channels = subject
+        channels.first.channel_group_id.should == 1
         channels.first.comment.should == "DummyComment"
         channels.first.epg_url.should == "http://example.com/epg-url"
-        channels.first.group_id.should == 1
         channels.first.id.should == 3
         channels.first.iepg_name.should == "DummyiEPGName"
         channels.first.name.should == "DummyChannelName"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syoboi_calendar
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -167,14 +167,17 @@ files:
 - lib/syoboi_calendar.rb
 - lib/syoboi_calendar/client.rb
 - lib/syoboi_calendar/queries/base_query.rb
+- lib/syoboi_calendar/queries/channel_group_query.rb
 - lib/syoboi_calendar/queries/channel_query.rb
 - lib/syoboi_calendar/queries/program_query.rb
 - lib/syoboi_calendar/queries/title_query.rb
 - lib/syoboi_calendar/resources/base_resource.rb
+- lib/syoboi_calendar/resources/channel_group_resource.rb
 - lib/syoboi_calendar/resources/channel_resource.rb
 - lib/syoboi_calendar/resources/program_resource.rb
 - lib/syoboi_calendar/resources/title_resource.rb
 - lib/syoboi_calendar/responses/base_response.rb
+- lib/syoboi_calendar/responses/channel_groups_response.rb
 - lib/syoboi_calendar/responses/channels_response.rb
 - lib/syoboi_calendar/responses/programs_response.rb
 - lib/syoboi_calendar/responses/titles_response.rb