syoboi_calendar 0.3.1 → 0.4.0

data/lib/syoboi_calendar/client.rb

@@ -1,14 +1,17 @@
 module SyoboiCalendar
   class Client
-    def channels(options = {})
+    # @return [Array<SyoboiCalendar::Resources::Channel>]
+    def list_channels(options = {})
       Processors::Channel.process(options)
     end
 
-    def programs(options = {})
+    # @return [Array<SyoboiCalendar::Resources::Program>]
+    def list_programs(options = {})
       Processors::Program.process(options)
     end
 
-    def titles(options = {})
+    # @return [Array<SyoboiCalendar::Resources::Title>]
+    def list_titles(options = {})
       Processors::Title.process(options)
     end
   end

data/lib/syoboi_calendar/parsers/channel.rb

@@ -8,7 +8,7 @@ module SyoboiCalendar
       end
 
       def items
-        Array.wrap(response.ChLookupResponse.ChItems.ChItem)
+        ::Array.wrap(response.ChLookupResponse.ChItems.ChItem)
       end
     end
   end

data/lib/syoboi_calendar/parsers/program.rb

@@ -8,7 +8,7 @@ module SyoboiCalendar
       end
 
       def items
-        Array.wrap(response.ProgLookupResponse.ProgItems.ProgItem)
+        ::Array.wrap(response.ProgLookupResponse.ProgItems.ProgItem)
       end
     end
   end

data/lib/syoboi_calendar/parsers/title.rb

@@ -8,7 +8,7 @@ module SyoboiCalendar
       end
 
       def items
-        Array.wrap(response.TitleLookupResponse.TitleItems.TitleItem)
+        ::Array.wrap(response.TitleLookupResponse.TitleItems.TitleItem)
       end
     end
   end

data/lib/syoboi_calendar/processors/base.rb

@@ -36,7 +36,7 @@ module SyoboiCalendar
       end
 
       def includes
-        Array.wrap(options[:includes])
+        ::Array.wrap(options[:includes])
       end
     end
   end

data/lib/syoboi_calendar/resources/base.rb

@@ -1,14 +1,17 @@
 module SyoboiCalendar
   module Resources
     class Base
+      # @return [Hashie::Mash]
       attr_reader :response
 
+      # @param response [Hashie::Mash]
       def initialize(response)
         @response = response
       end
 
+      # @return [Time]
       def updated_at
-        Time.parse(response.LastUpdate)
+        ::Time.parse(response.LastUpdate)
       end
     end
   end

data/lib/syoboi_calendar/resources/channel.rb

@@ -1,37 +1,45 @@
 module SyoboiCalendar
   module Resources
     class Channel < Base
+      # @return [String, nil]
       def comment
         response.ChComment
       end
 
+      # @return [String, nil]
       def epg_url
         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)
       end
 
+      # @return [String, nil]
+      def iepg_name
+        response.ChiEPGName
+      end
+
+      # @return [String, nil]
       def name
         response.ChName
       end
 
+      # @return [Integer, nil]
       def number
         response.ChNumber.try(:to_i)
       end
 
+      # @return [String, nil]
       def url
         response.ChURL
       end
-
-      def iepg_name
-        response.ChiEPGName
-      end
     end
   end
 end

data/lib/syoboi_calendar/resources/program.rb

@@ -1,55 +1,76 @@
 module SyoboiCalendar
   module Resources
     class Program < Base
-      attr_accessor :channel, :title
+      # @return [SyoboiCalendar::Resources::Channel, nil]
+      attr_accessor :channel
 
-      def id
-        response.PID.try(:to_i)
-      end
-
-      def title_id
-        response.TID.try(:to_i)
-      end
+      # @return [SyoboiCalendar::Resources::Title, nil]
+      attr_accessor :title
 
-      def started_at
-        Time.parse(response.StTime)
+      # @return [Integer, nil]
+      def channel_id
+        response.ChID.try(:to_i)
       end
 
-      def finished_at
-        Time.parse(response.EdTime)
+      # @return [String, nil]
+      def comment
+        response.ProgComment
       end
 
+      # @return [Integer, nil]
       def count
         response.Count.try(:to_i)
       end
 
-      def sub_title
-        response.STSubTitle
-      end
-
-      def comment
-        response.ProgComment
+      # @return [Boolean]
+      def deleted?
+        response.Deleted != "0"
       end
 
+      # @return [Integer, nil]
       def flag
         response.Flag.try(:to_i)
       end
 
-      def deleted?
-        response.Deleted != "0"
+      # @return [Integer, nil]
+      def id
+        response.PID.try(:to_i)
       end
 
-      def warn
-        response.Warn.try(:to_i)
+      # @return [String, nil]
+      def iepg_name
+        response.ChiEPGName
       end
 
-      def channel_id
-        response.ChID.try(:to_i)
+      # @return [Time]
+      def finished_at
+        ::Time.parse(response.EdTime)
       end
 
+      # @return [Integer, nil]
       def revision
         response.Revision.try(:to_i)
       end
+
+      # @return [Time]
+      def started_at
+        ::Time.parse(response.StTime)
+      end
+
+      # @return [String, nil]
+      def sub_title
+        response.STSubTitle
+      end
+
+      # @return [Integer]
+      def title_id
+        response.TID.try(:to_i)
+      end
+
+      # @return [Integer, nil]
+      def warn
+        response.Warn.try(:to_i)
+      end
     end
   end
 end

data/lib/syoboi_calendar/resources/title.rb

@@ -1,70 +1,87 @@
 module SyoboiCalendar
   module Resources
     class Title < Base
+      # @return [Integer, nil]
       def category_id
         response.Cat.try(:to_i)
       end
 
+      # @return [String, nil]
       def comment
         response.Comment
       end
 
+      # @return [String, nil]
+      def english_name
+        response.TitleEN
+      end
+
+      # @return [String, nil]
       def first_channel
         response.FirstCh
       end
 
+      # @return [Integer, nil]
       def first_end_month
         response.FirstEndMonth.try(:to_i)
       end
 
+      # @return [Integer, nil]
       def first_end_year
         response.FirstEndYear.try(:to_i)
       end
 
+      # @return [Integer, nil]
       def first_month
         response.FirstMonth.try(:to_i)
       end
 
+      # @return [Integer, nil]
       def first_year
         response.FirstYear.try(:to_i)
       end
 
-      def keywords
-        response.Keywords
-      end
-
-      def short_title
-        response.ShortTitle
-      end
-
-      def sub_titles
-        response.SubTitles
-      end
-
+      # @return [Integer, nil]
       def id
         response.TID.try(:to_i)
       end
 
+      # @return [String, nil]
       def name
         response.Title
       end
 
-      def english_name
-        response.TitleEN
-      end
-
+      # @return [Integer, nil]
       def flag
         response.TitleFlag.try(:to_i)
       end
 
+      # @return [String, nil]
       def kana
         response.TitleYomi
       end
 
+      # @return [String, nil]
+      def keywords
+        response.Keywords
+      end
+
+      # @return [String, nil]
+      def short_title
+        response.ShortTitle
+      end
+
+      # @return [String, nil]
+      def sub_titles
+        response.SubTitles
+      end
+
+      # @return [Integer, nil]
       def point
         response.UserPoint.try(:to_i)
       end
 
+      # @return [Integer, nil]
       def rank
         response.UserPointRank.try(:to_i)
       end

data/lib/syoboi_calendar/version.rb

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

data/spec/spec_helper.rb

@@ -1,14 +1,5 @@
-require "simplecov"
-SimpleCov.start
-
 require "webmock/rspec"
 
-if ENV["CI"]
-  WebMock.disable_net_connect!(allow: "codeclimate.com")
-  require "codeclimate-test-reporter"
-  CodeClimate::TestReporter.start
-end
-
 require "syoboi_calendar"
 require "rack"
 require "active_support/all"