tvtid 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4fed7edb8d062f0e970ea68728474290b4c4f0c
+  data.tar.gz: c54fd7e6cceb49c6c659a8362adc1d88cede8bbe
+SHA512:
+  metadata.gz: f0899ab3cbd46626d7c1214b3a6c6912b0d6db747f3177d669b88d9c041d47bf62346b05f79f89c3ee5ed422ccde58b1237de2fc41a31c261956c3ddd0291ac5
+  data.tar.gz: b9d639a7c57e2bc49d3c37db1a1c0189e5fac2eb4a5b577a77e3f9a83b4a7aeb13b8464db7b274f3f7193758336f302dab7d3e67c67a6be72b64852e65e66923

data/.yardopts

@@ -0,0 +1,5 @@
+--output-dir documentation/
+--readme README.md
+--title TVTid
+--protected
+library/**/*.rb

data/README.md

@@ -0,0 +1,2 @@
+tvtid
+=====

data/library/tvtid.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'net/http'
+
+require 'oj'
+require 'lrucache'
+require 'multi_json'
+
+require 'tvtid/client'
+require 'tvtid/channel'
+require 'tvtid/program'
+require 'tvtid/schedule'
+require 'tvtid/category'
+
+module TVTid
+end

data/library/tvtid/category.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module TVTid
+  # A category for an EPG entry.
+  class Category
+    attr_accessor :color, :shade
+    attr_reader :name
+
+    # Constructs a new category with a name.
+    def initialize name
+      @name = name
+    end
+
+    # Creates a new category from a json object.
+    #
+    # @returns a category.
+    def self.from_json json
+      return nil unless json['name']
+
+      Category.new(json['name']).tap do |category|
+        category.color = json['color']
+        category.shade = json['shade']
+      end
+    end
+  end
+end

data/library/tvtid/channel.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module TVTid
+  class Channel
+    attr_accessor :icon, :logo, :logo_svg, :category, :region, :language
+    attr_reader :id, :title
+
+    # Constructs a new channel with an id and a title.
+    def initialize id, title
+      @id = id
+      @title = title
+    end
+
+    # Creates a new channel from a json object.
+    # 
+    # @returns a channel.
+    def self.from_json json
+      return nil unless json['id'] and json['title']
+
+      Channel.new(json['id'], json['title']).tap do |channel|
+        channel.icon = json['icon']
+        channel.logo = json['logo']
+        channel.logo_svg = json['svgLogo']
+        channel.category = json['category']
+        channel.region = json['region']
+        channel.language = json['lang']
+      end
+    end
+  end
+end

data/library/tvtid/client.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+module TVTid
+  class Client
+    # The cache time to live.
+    CACHE_TTL = 1 * 60 * 60 * 24 # 1 day
+    # The soft cache time to live.
+    CACHE_SOFT_TTL = 7 * 60 * 60 * 24 # 7 days
+    # The API backend host.
+    API_BASE_URI = URI 'http://tvtid-app-backend.tv2.dk'
+
+    # The default HTTP request headers
+    HTTP_REQUEST_HEADERS = {
+      'User-Agent' => 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.76 Safari/537.36'
+    }
+
+    # The default channels to return in a days schedule
+    DEFAULT_CHANNELS = [1, 3, 5, 2, 31, 133, 7, 6, 4, 10155, 10154, 10153, 8,
+                        77,   156,  10093,  10066,  14, 10089, 12566, 10111, 70,
+                        118, 153, 94, 12948, 145, 185, 157, 15, 71, 93, 15049,
+                        219, 37, 248, 186]
+
+    # 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
+    #
+    # @param date A date
+    # @param channels A list of channel ids to request schedules for
+    def schedules_for date, channels = []
+      return nil unless date.is_a? Date
+
+      channels = self.channels.select{|c| DEFAULT_CHANNELS.include? c.id } if channels.empty?
+      formatted_date = date.iso8601
+      cache_key = "schedule-#{formatted_date}-#{channels.map(&:id).join ','}"
+
+      @cache.fetch cache_key do
+        channel_queries = channels.map{|c| "ch=#{c.id}" }.join '&'
+        response = @http.get "/api/tvtid/v1/dayviews/#{formatted_date}?#{channel_queries}", HTTP_REQUEST_HEADERS
+        json_data = MultiJson.load response.body
+
+        json_data.map do |schedule|
+          channel = channels.find{|channel| channel.id == schedule['id']}
+          programs = schedule['programs'].map{|program| Program.from_json program }
+
+          Schedule.new channel, programs
+        end
+      end
+    end
+
+    # Returns a list of schedules for today
+    #
+    # This is the same as using `schedules_for Date.today`
+    def schedules_for_today channels = []
+      schedules_for Date.today, channels
+    end
+
+    # Returns a days schedule for a given channel and date
+    #
+    # @param channel [Channel] The channel to get the schedule for
+    # @param date [Date] The date of the schedule
+    def channel_schedule channel, date = Date.today
+      schedules_for(date, [channel]).first
+    end
+
+    # Returns a list of channels
+    def channels
+      @cache.fetch 'channels' do
+        response = @http.get '/api/tvtid/v1/channels', HTTP_REQUEST_HEADERS
+
+        json_data = MultiJson.load response.body
+        json_data.map{|json_channel_data| Channel.from_json json_channel_data }
+      end
+    end
+  end
+end

data/library/tvtid/program.rb

@@ -0,0 +1,64 @@
+module TVTid
+  class Program
+    # The id of the program.
+    attr_reader :id
+    # The title of the program.
+    attr_reader :title
+    # The time the program starts at.
+    attr_accessor :start_time
+    # The time the program stops at.
+    attr_accessor :stop_time
+    # A url where the user can see more information about the program.
+    attr_accessor :url
+    # The ID of the channel.
+    attr_accessor :channel_id
+    # The category of the program.
+    attr_accessor :category
+    # The description of the program.
+    attr_accessor :description
+    # The original non-localized title of the program.
+    attr_accessor :original_title
+    # The year of production of the program.
+    attr_accessor :production_year
+    # The production country of the program.
+    attr_accessor :production_country
+    # Teaser text for the program.
+    attr_accessor :teaser
+    # Unique series id if the program is a series.
+    attr_accessor :series_id
+    # Episode and season information if the program is a series.
+    attr_accessor :series_info
+
+    # Constructs a new `Program` with an `id` and a `title`.
+    def initialize id, title
+      @id = id
+      @title = title
+    end
+
+    # Updates the program information from a json object.
+    def parse_json! json
+      @start_time = Time.at(json['start']).to_datetime
+      @stop_time = Time.at(json['stop']).to_datetime
+      @url = json['url'] if json.key?('url')
+      @channel_id = json['channelId'] if json.key?('channelId')
+      @category = json['category'] if json.key?('category')
+      @description = json['desc'] if json.key?('desc')
+      @production_year = json['prodYear'] if json.key?('prodYear')
+      @production_country = json['prodCountry'] if json.key?('prodCountry')
+      @teaser = json['teaser'] if json.key?('teaser')
+      @series_id = json['series_id'] if json.key?('seriesId')
+      @series_info = json['series'] if json.key?('series')
+    end
+
+    # Constructs a `Program` from a json object.
+    #
+    # @returns Program if json object has an `id` and a `title` - nil otherwise.
+    def self.from_json json
+      return nil unless json['id'] and json['title']
+
+      Program.new(json['id'], json['title']).tap do |program|
+        program.parse_json! json
+      end
+    end
+  end
+end

data/library/tvtid/schedule.rb

@@ -0,0 +1,14 @@
+module TVTid
+  class Schedule
+    # The channel the schedule belongs to.
+    attr_reader :channel
+    # The list of programs in the schedule.
+    attr_reader :programs
+
+    # Constructs a new schedule for a `channel`.
+    def initialize channel, programs = []
+      @channel = channel
+      @programs = programs
+    end
+  end
+end

data/library/tvtid/version.rb

@@ -0,0 +1,3 @@
+module TVTid
+  Version = '0.1'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: tvtid
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Mikkel Kroman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: lrucache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+description: 
+email: mk@uplink.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- README.md
+- library/tvtid.rb
+- library/tvtid/category.rb
+- library/tvtid/channel.rb
+- library/tvtid/client.rb
+- library/tvtid/program.rb
+- library/tvtid/schedule.rb
+- library/tvtid/version.rb
+homepage: https://github.com/mkroman/tvtid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- library
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Client library for tvtid.tv2.dk
+test_files: []