syoboi_calendar 0.7.0 → 0.8.0

data/lib/syoboi_calendar/client.rb

@@ -1,3 +1,6 @@
+require "faraday"
+require "faraday_middleware"
+
 module SyoboiCalendar
   class Client
     ENDPOINT_BASE_URL = "http://cal.syoboi.jp"
@@ -7,47 +10,48 @@ module SyoboiCalendar
     def connection
       @connection ||= ::Faraday::Connection.new(url: ENDPOINT_BASE_URL) do |connection|
         connection.adapter :net_http
+        connection.response :xml
         connection.response :raise_error
       end
     end
 
-    # @return [Array<SyoboiCalendar::Resources::ChannelGroup>]
+    # @param options [Hash]
+    # @return [SyoboiCalendar::Response]
     def list_channel_groups(options = {})
-      query = ::SyoboiCalendar::Queries::ChannelGroupQuery.new(options)
-      faraday_response = get(query.to_hash)
-      ::SyoboiCalendar::Response.new(
-        faraday_response: faraday_response,
-        response_parser_class: ::SyoboiCalendar::ResponseParsers::ChannelGroupsResponseParser,
+      list(
+        options: options,
+        query_class: ::SyoboiCalendar::Queries::ListChannelGroupsQuery,
+        response_class: ::SyoboiCalendar::Responses::ListChannelGroupsResponse,
       )
     end
 
-    # @return [Array<SyoboiCalendar::Resources::Channel>]
+    # @param options [Hash]
+    # @return [SyoboiCalendar::Response]
     def list_channels(options = {})
-      query = ::SyoboiCalendar::Queries::ChannelQuery.new(options)
-      faraday_response = get(query.to_hash)
-      ::SyoboiCalendar::Response.new(
-        faraday_response: faraday_response,
-        response_parser_class: ::SyoboiCalendar::ResponseParsers::ChannelsResponseParser,
+      list(
+        options: options,
+        query_class: ::SyoboiCalendar::Queries::ListChannelsQuery,
+        response_class: ::SyoboiCalendar::Responses::ListChannelsResponse,
       )
     end
 
-    # @return [Array<SyoboiCalendar::Resources::Program>]
+    # @param options [Hash]
+    # @return [SyoboiCalendar::Response]
     def list_programs(options = {})
-      query = ::SyoboiCalendar::Queries::ProgramQuery.new(options)
-      faraday_response = get(query.to_hash)
-      ::SyoboiCalendar::Response.new(
-        faraday_response: faraday_response,
-        response_parser_class: ::SyoboiCalendar::ResponseParsers::ProgramsResponseParser,
+      list(
+        options: options,
+        query_class: ::SyoboiCalendar::Queries::ListProgramsQuery,
+        response_class: ::SyoboiCalendar::Responses::ListProgramsResponse,
       )
     end
 
-    # @return [Array<SyoboiCalendar::Resources::Title>]
+    # @param options [Hash]
+    # @return [SyoboiCalendar::Response]
     def list_titles(options = {})
-      query = ::SyoboiCalendar::Queries::TitleQuery.new(options)
-      faraday_response = get(query.to_hash)
-      ::SyoboiCalendar::Response.new(
-        faraday_response: faraday_response,
-        response_parser_class: ::SyoboiCalendar::ResponseParsers::TitlesResponseParser,
+      list(
+        options: options,
+        query_class: ::SyoboiCalendar::Queries::ListTitlesQuery,
+        response_class: ::SyoboiCalendar::Responses::ListTitlesResponse,
       )
     end
 
@@ -59,5 +63,16 @@ module SyoboiCalendar
     def get(query)
       connection.get(ENDPOINT_PATH, query)
     end
+
+    # @private
+    # @param options [Hash]
+    # @param query_class [Class]
+    # @param response_class [Class]
+    # @return [SyoboiCalendar::Responses::ListBaseResponse]
+    def list(options:, query_class:, response_class:)
+      query = query_class.new(options)
+      faraday_response = get(query.to_hash)
+      response_class.new(faraday_response)
+    end
   end
 end

data/lib/syoboi_calendar/queries/{channel_group_query.rb → list_channel_groups_query.rb}

@@ -1,6 +1,6 @@
 module SyoboiCalendar
   module Queries
-    class ChannelGroupQuery < BaseQuery
+    class ListChannelGroupsQuery < BaseQuery
       COMMAND = "ChGroupLookup"
 
       property :ChGID

data/lib/syoboi_calendar/queries/{channel_query.rb → list_channels_query.rb}

@@ -1,6 +1,6 @@
 module SyoboiCalendar
   module Queries
-    class ChannelQuery < BaseQuery
+    class ListChannelsQuery < BaseQuery
       COMMAND = "ChLookup"
 
       property :ChID

data/lib/syoboi_calendar/queries/{program_query.rb → list_programs_query.rb}

@@ -1,6 +1,6 @@
 module SyoboiCalendar
   module Queries
-    class ProgramQuery < BaseQuery
+    class ListProgramsQuery < BaseQuery
       COMMAND = "ProgLookup"
 
       JOIN = "SubTitles"

data/lib/syoboi_calendar/queries/{title_query.rb → list_titles_query.rb}

@@ -1,6 +1,6 @@
 module SyoboiCalendar
   module Queries
-    class TitleQuery < BaseQuery
+    class ListTitlesQuery < BaseQuery
       COMMAND = "TitleLookup"
 
       property :Fields

data/lib/syoboi_calendar/resources/base_resource.rb

@@ -1,3 +1,5 @@
+require "time"
+
 module SyoboiCalendar
   module Resources
     class BaseResource

data/lib/syoboi_calendar/resources/program_resource.rb

@@ -1,3 +1,5 @@
+require "time"
+
 module SyoboiCalendar
   module Resources
     class ProgramResource < BaseResource

data/lib/syoboi_calendar/responses/base_response.rb

@@ -0,0 +1,93 @@
+module SyoboiCalendar
+  module Responses
+    class BaseResponse
+      include ::Enumerable
+
+      # @param faraday_response [Faraday::Response]
+      def initialize(faraday_response)
+        @faraday_response = faraday_response
+      end
+
+      # @return [String]
+      def body
+        faraday_response.body
+      end
+
+      # @return [Integer]
+      def code
+        body[response_key]["Result"]["Code"].to_i
+      end
+
+      # @note Implementation for Enumerable
+      def each(&block)
+        resources.each(&block)
+      end
+
+      # @return [Boolean]
+      def has_error?
+        code != 200
+      end
+
+      # @return [Faraday::Utils::Headers]
+      def headers
+        faraday_response.headers
+      end
+
+      # @return [String, nil]
+      def message
+        body[response_key]["Result"]["Message"]
+      end
+
+      # @return [Array<SyoboiCalendar::Resources::BaseResource>]
+      def resources
+        sources.map do |source|
+          resource_class.new(source)
+        end
+      end
+
+      # @return [Integer]
+      def status
+        faraday_response.status
+      end
+
+      private
+
+      # @return [Faraday::Response]
+      def faraday_response
+        @faraday_response
+      end
+
+      # @return [Class]
+      def resource_class
+        raise ::NotImplementedError
+      end
+
+      # @return [String]
+      def response_key
+        raise ::NotImplementedError
+      end
+
+      # @return [Array<Hash>, Hash]
+      def source_or_sources
+        raise ::NotImplementedError
+      end
+
+      # @return [Array<Hash>]
+      def sources
+        if has_error?
+          []
+        else
+          object = source_or_sources
+          case
+          when object.nil?
+            []
+          when object.respond_to?(:to_ary)
+            object.to_ary || [object]
+          else
+            [object]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/syoboi_calendar/{response_parsers/channel_groups_response_parser.rb → responses/list_channel_groups_response.rb}

@@ -1,6 +1,6 @@
 module SyoboiCalendar
-  module ResponseParsers
-    class ChannelGroupsResponseParser < BaseResponseParser
+  module Responses
+    class ListChannelGroupsResponse < BaseResponse
       private
 
       # @note Override
@@ -8,9 +8,14 @@ module SyoboiCalendar
         ::SyoboiCalendar::Resources::ChannelGroupResource
       end
 
+      # @note Override
+      def response_key
+        "ChGroupLookupResponse"
+      end
+
       # @note Override
       def source_or_sources
-        parsed_body["ChGroupLookupResponse"]["ChGroupItems"]["ChGroupItem"]
+        body[response_key]["ChGroupItems"]["ChGroupItem"]
       end
     end
   end

data/lib/syoboi_calendar/{response_parsers/channels_response_parser.rb → responses/list_channels_response.rb}

@@ -1,6 +1,6 @@
 module SyoboiCalendar
-  module ResponseParsers
-    class ChannelsResponseParser < BaseResponseParser
+  module Responses
+    class ListChannelsResponse < BaseResponse
       private
 
       # @note Override
@@ -8,9 +8,14 @@ module SyoboiCalendar
         ::SyoboiCalendar::Resources::ChannelResource
       end
 
+      # @note Override
+      def response_key
+        "ChLookupResponse"
+      end
+
       # @note Override
       def source_or_sources
-        parsed_body["ChLookupResponse"]["ChItems"]["ChItem"]
+        body[response_key]["ChItems"]["ChItem"]
       end
     end
   end

data/lib/syoboi_calendar/{response_parsers/programs_response_parser.rb → responses/list_programs_response.rb}

@@ -1,6 +1,6 @@
 module SyoboiCalendar
-  module ResponseParsers
-    class ProgramsResponseParser < BaseResponseParser
+  module Responses
+    class ListProgramsResponse < BaseResponse
       private
 
       # @note Override
@@ -8,9 +8,14 @@ module SyoboiCalendar
         ::SyoboiCalendar::Resources::ProgramResource
       end
 
+      # @note Override
+      def response_key
+        "ProgLookupResponse"
+      end
+
       # @note Override
       def source_or_sources
-        parsed_body["ProgLookupResponse"]["ProgItems"]["ProgItem"]
+        body[response_key]["ProgItems"]["ProgItem"]
       end
     end
   end

data/lib/syoboi_calendar/{response_parsers/titles_response_parser.rb → responses/list_titles_response.rb}

@@ -1,6 +1,6 @@
 module SyoboiCalendar
-  module ResponseParsers
-    class TitlesResponseParser < BaseResponseParser
+  module Responses
+    class ListTitlesResponse < BaseResponse
       private
 
       # @note Override
@@ -8,9 +8,14 @@ module SyoboiCalendar
         ::SyoboiCalendar::Resources::TitleResource
       end
 
+      # @note Override
+      def response_key
+        "TitleLookupResponse"
+      end
+
       # @note Override
       def source_or_sources
-        parsed_body["TitleLookupResponse"]["TitleItems"]["TitleItem"]
+        body[response_key]["TitleItems"]["TitleItem"]
       end
     end
   end

data/lib/syoboi_calendar/version.rb

@@ -1,3 +1,3 @@
 module SyoboiCalendar
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/syoboi_calendar.rb

@@ -1,21 +1,16 @@
-require "faraday"
-require "faraday_middleware"
-require "multi_xml"
-
 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/queries/list_channel_groups_query"
+require "syoboi_calendar/queries/list_channels_query"
+require "syoboi_calendar/queries/list_programs_query"
+require "syoboi_calendar/queries/list_titles_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/response"
-require "syoboi_calendar/response_parsers/base_response_parser"
-require "syoboi_calendar/response_parsers/channel_groups_response_parser"
-require "syoboi_calendar/response_parsers/channels_response_parser"
-require "syoboi_calendar/response_parsers/programs_response_parser"
-require "syoboi_calendar/response_parsers/titles_response_parser"
+require "syoboi_calendar/responses/base_response"
+require "syoboi_calendar/responses/list_channel_groups_response"
+require "syoboi_calendar/responses/list_channels_response"
+require "syoboi_calendar/responses/list_programs_response"
+require "syoboi_calendar/responses/list_titles_response"

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require "active_support/core_ext/object/to_query"
 require "active_support/core_ext/string/strip"
-require "rack"
 require "syoboi_calendar"
 require "webmock/rspec"