tvtid 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea4bedf76b78e369cfac3ad2e67444f5172c64b0
-  data.tar.gz: 6c37d809faef50bd339f0678233744d9c554db91
+  metadata.gz: 36fbfc05fddc5323e3c0e56abf9ced86dc074474
+  data.tar.gz: 310a1705cfae16aa41e43b6fed1a8c7b4e9478f3
 SHA512:
-  metadata.gz: 1bec9af98fa1f916b41a46946b35bef2a5b9feccef34d66a562aaf5975bd80c2911740d08ebe17575ac001839713695bfb44f5b94225846b5419835418ace21b
-  data.tar.gz: '093bb630fb49e60928a4219c27515d65d2f935ae23c364bed377115383f4e42246db53af4bcd34f1a047fadd91869c8de0a3dcdebf0b4e45b36431c5cd5c5202'
+  metadata.gz: 4cff228acd985786abea49798e260d243a271754620e56e1a5e89e64b6570476558d1dba1de25efb9be505238c3c36758b5cf167d6b98837f380427ca7c07d24
+  data.tar.gz: 5605ff062067d737fa91e69142d16174c735955c3e4917541ea2d4714bc45dd3a10658066a5e2edc9f045306d74126c974a0b4777d7c5bf2cf58426d0bd75244

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017, Mikkel Kroman <mk@uplink.io>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -1,2 +1,39 @@
-tvtid
-=====
+# TVTid
+This is a Ruby library for interfacing with the unofficial API on `tvtid.tv2.dk`.
+
+[![Build Status](https://travis-ci.org/mkroman/tvtid.svg?branch=master)](https://travis-ci.org/mkroman/tvtid)
+[![Dependency Status](https://gemnasium.com/mkroman/tvtid.svg)](https://gemnasium.com/mkroman/tvtid)
+
+## Example
+```ruby
+require 'tvtid'
+
+client = TVTid::Client.new
+schedules = client.schedules_for_today
+channel_length = client.channels.map(&:title).map(&:length).max
+
+schedules.each do |schedule|
+  channel = schedule.channel
+  already_aired_programs, currently_running_program, upcoming_programs = schedule.current
+  
+  if program = currently_running_program
+    print "#{channel.title.ljust channel_length} [#{program.start_time.strftime('%R')}] #{program.title} "
+    
+    upcoming_programs[0...2].each do |program|
+      print "[#{program.start_time.strftime('%R')}] #{program.title} "
+    end
+    
+    puts
+  end
+end
+
+# TV 2          [20:00] Fuld plade [21:15] Baby Surprise [23:05] Obsessed 
+# DR1           [20:00] X Factor [21:00] TV AVISEN [21:15] Vores vejr 
+# TV 2 Charlie  [20:30] Fede Finn i modvind [21:25] Fede Finn i modvind [22:15] En sag for Frost 
+# DR2           [20:45] VM håndbold: Kroatien-Norge, direkte [21:20] VM håndbold: Studiet [21:35] VM håndbold: Kroatien-Norge, direkte 
+# TV3           [20:00] Dagens mand [21:00] American Pie 2 [23:10] The Joneses
+# …
+```
+
+## License
+`tvtid` is published under the MIT license which can be read in the `LICENSE` file.

data/library/tvtid/client.rb

@@ -20,16 +20,17 @@ module TVTid
                         118, 153, 94, 12948, 145, 185, 157, 15, 71, 93, 15049,
                         219, 37, 248, 186]
 
-    # Constructs a new client
+    # Constructs a new client.
     def initialize
       @cache = LRUCache.new ttl: CACHE_TTL, soft_ttl: CACHE_SOFT_TTL
       @http = Net::HTTP.new API_BASE_URI.host, API_BASE_URI.port
     end
 
-    # Returns a schedule for the given date
+    # Returns a schedule for the provided channels the given date
     #
     # @param date A date
     # @param channels A list of channel ids to request schedules for
+    # @return [Array<Schedule>] the list of schedules
     def schedules_for date, channels = []
       return nil unless date.is_a? Date
 
@@ -44,7 +45,11 @@ module TVTid
 
         json_data.map do |schedule|
           channel = channels.find{|channel| channel.id == schedule['id']}
-          programs = schedule['programs'].map{|program| Program.from_json program }
+          programs = schedule['programs'].map do |program|
+            program = Program.from_json program
+            program.channel_id = schedule['id']
+            program
+          end
           programs.sort!{|a, b| a.start_time <=> b.start_time }
 
           Schedule.new channel, programs
@@ -54,7 +59,7 @@ module TVTid
 
     # Returns a list of schedules for today
     #
-    # This is the same as using `schedules_for Date.today`
+    # This is equivalent to using `chedules_for Date.today`
     def schedules_for_today channels = []
       schedules_for Date.today, channels
     end
@@ -76,5 +81,18 @@ module TVTid
         json_data.map{|json_channel_data| Channel.from_json json_channel_data }
       end
     end
+
+    # Retrieves program details and updates the given program object.
+    #
+    # @return [Program] the program
+    def get_program_details! program
+      response = @http.get "/api/tvtid/v1/channels/#{program.channel_id}/programs/#{program.id}", HTTP_REQUEST_HEADERS
+
+      if response.code == '200'
+        program.parse_json! MultiJson.load(response.body)
+      end
+
+      program
+    end
   end
 end

data/library/tvtid/program.rb

@@ -1,32 +1,34 @@
 module TVTid
   class Program
-    # The id of the program.
+    # @return [Numeric] the id of the program.
     attr_reader :id
-    # The title of the program.
+    # @return [String] the title of the program.
     attr_reader :title
-    # The time the program starts at.
+    # @return [DateTime] the time the program starts at.
     attr_accessor :start_time
-    # The time the program stops at.
+    # @return [DateTime] the time the program ends at.
     attr_accessor :stop_time
-    # A url where the user can see more information about the program.
+    # @return [String] a URL to where the user can see more information about
+    #   the program.
     attr_accessor :url
-    # The ID of the channel.
+    # @return [Numeric] the ID of the channel.
     attr_accessor :channel_id
-    # The category of the program.
+    # @return [String] the category of the program.
     attr_accessor :category
-    # The description of the program.
+    # @return [String] the description of the program.
     attr_accessor :description
-    # The original non-localized title of the program.
+    # @return [String] the original non-localized title of the program.
     attr_accessor :original_title
-    # The year of production of the program.
+    # @return [Numeric] the year of production of the program.
     attr_accessor :production_year
-    # The production country of the program.
+    # @return [String] the production country of the program.
     attr_accessor :production_country
-    # Teaser text for the program.
+    # @return [String] the teaser text of the program.
     attr_accessor :teaser
-    # Unique series id if the program is a series.
+    # @return [Numeric] a unique series id if the program is a series.
     attr_accessor :series_id
-    # Episode and season information if the program is a series.
+    # @return [Hash, nil] episode and season information if the program is a
+    #   series.
     attr_accessor :series_info
 
     # Constructs a new `Program` with an `id` and a `title`.
@@ -36,6 +38,8 @@ module TVTid
     end
 
     # Updates the program information from a json object.
+    #
+    # @param json [Hash] Parsed JSON object
     def parse_json! json
       @start_time = Time.at(json['start']).to_datetime
       @stop_time = Time.at(json['stop']).to_datetime
@@ -52,7 +56,9 @@ module TVTid
 
     # Constructs a `Program` from a json object.
     #
-    # @returns Program if json object has an `id` and a `title` - nil otherwise.
+    # @param json [Hash] Parsed JSON object
+    # @return [Program, nil] program if the given `json` object has an `id` 
+    #   and a `title` attribute, nil otherwise.
     def self.from_json json
       return nil unless json['id'] and json['title']
 

data/library/tvtid/schedule.rb

@@ -1,19 +1,23 @@
 module TVTid
   class Schedule
-    # The channel the schedule belongs to.
+    # @return [Channel] the channel the schedule belongs to.
     attr_reader :channel
-    # The list of programs in the schedule.
+    # @return [Array<Program>] the list of programs in the schedule.
     attr_reader :programs
 
-    # Constructs a new schedule for a `channel`.
+    # Constructs a new schedule for a channel.
+    #
+    # @param channel [Channel] the parent channel
+    # @param programs [Array<Program>] a list of programs
     def initialize channel, programs = []
       @channel = channel
       @programs = programs
     end
 
-    # Get the previous, current and upcoming programs at a given `time`.
+    # Returns the previous, current and upcoming programs at a given `time`.
     #
-    # @returns [previous<Array>, current<Program>, upcoming<Array>]
+    # @return [(Array<Program>, Program, Array<Program>)] the previous, the
+    #   current and the upcoming programs relative to the given `time`.
     def at time
       cur_idx = 0
 
@@ -29,9 +33,8 @@ module TVTid
       end
     end
 
-    # Returns the previous, current and upcoming programs.
-    #
-    # @see at
+    # @return [(Array<Program>, Program, Array<Program>)] the previous, the
+    #   current and the upcoming programs relative to the current time.
     def current
       self.at DateTime.now
     end

data/library/tvtid/version.rb

@@ -1,3 +1,3 @@
 module TVTid
-  Version = '0.2'
+  Version = '0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tvtid
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Mikkel Kroman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2017-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -52,6 +52,120 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.18'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.3
 description: 
 email: mk@uplink.io
 executables: []
@@ -59,6 +173,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
+- LICENSE
 - README.md
 - library/tvtid.rb
 - library/tvtid/category.rb
@@ -79,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.1
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="