chromecast 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab0190901c9fd66715415de2eded3dea8404e4cb
+  data.tar.gz: 3ce530143c686dc4cb515e708ab6b00999af77fd
+SHA512:
+  metadata.gz: a6f3a8461d4a2260def97f0f7c7f1c06fe66f4d994e0ec733899c399d1d5d2d0ac9bc53aae4c727a243fa64e5f03c2b190a1b2148e726e04787bf73d516fb9c9
+  data.tar.gz: 0b80dd58061653159e6646792aca290fca6f2fa80a49c19f79f5d08c0c3b8da888970ba21e06860f3eaad07a2f7d102cfcbcab2360b34de2fa00e96353493a24

data/README.rdoc

@@ -0,0 +1,47 @@
+= chromecast
+
+A simple Ruby library you can use to monitor and control basic features of
+your Chromecast.
+
+== Quick start
+
+Install the gem:
+
+ gem install chromecast
+
+Or add it to your Gemfile:
+
+ gem "chromecast"
+
+Generate a certificate to be used for TLS connetion:
+
+ bundle exec rake setup:certificate
+
+Use it:
+
+ require 'chromecast'
+
+ c = Chromecast::Connection.new(CHROMECAST_IP).open
+ c.connection.connect
+
+ while true
+   msg = c.read
+
+   puts msg
+
+   if msg['type'] == 'PING'
+     c.heartbeat.pong
+   end
+ end
+
+== To Do
+
+* Scanning for devices
+* EventMachine support
+* Proper documentation
+* Tests
+* Support for more namespaces
+
+== License
+
+This gem is released under the {MIT License}[http://www.opensource.org/licenses/MIT].

data/chromecast.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+  s.name        = "chromecast"
+  s.version     = "1.0"
+  s.date        = "2014-10-04"
+  s.summary     = "Basic Chromecast controll via a Ruby library"
+  s.description = "The gem lets you monitor Chromecast status, control volume and launch apps."
+  s.authors     = ["Robert Nasiadek"]
+  s.files       = [
+    "init.rb",
+    "lib/chromecast.rb",
+    "lib/chromecast/tasks.rb",
+    "lib/chromecast/protocol.pb.rb",
+    "lib/chromecast/channel/media.rb",
+    "lib/chromecast/channel/connection.rb",
+    "lib/chromecast/channel/base.rb",
+    "lib/chromecast/channel/receiver.rb",
+    "lib/chromecast/channel/heartbeat.rb",
+    "lib/chromecast/connection.rb",
+    "lib/chromecast/application.rb",
+    "lib/chromecast/channel.rb",
+    "protocol.proto",
+    "README.rdoc",
+    "chromecast.gemspec"
+  ]
+  s.email       = "robert@kapati.net"
+  s.homepage    = "http://robzon.pl/"
+  s.license     = "MIT"
+
+  s.add_runtime_dependency 'ruby-tls', '~> 1.0'
+  s.add_runtime_dependency 'protobuf', '~> 3.3'
+end

data/init.rb

@@ -0,0 +1 @@
+require 'chromecast'

data/lib/chromecast.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'protobuf'
+
+require 'chromecast/protocol.pb'
+require 'chromecast/connection'
+require 'chromecast/channel'
+require 'chromecast/application'
+
+module Chromecast
+  APP_DEFAULT_MEDIA_RECEIVER  = 'CC1AD845'
+  APP_BACKDROP                = 'E8C28D3C'
+  APP_YOUTUBE                 = '233637DE'
+end

data/lib/chromecast/application.rb

@@ -0,0 +1,7 @@
+module Chromecast
+  module Application
+    DEFAULT_MEDIA_RECEIVER  = 'CC1AD845'
+    BACKDROP                = 'E8C28D3C'
+    YOUTUBE                 = '233637DE'
+  end
+end

data/lib/chromecast/channel.rb

@@ -0,0 +1,10 @@
+require_relative 'channel/base'
+require_relative 'channel/connection'
+require_relative 'channel/receiver'
+require_relative 'channel/heartbeat'
+require_relative 'channel/media'
+
+module Chromecast
+  module Channel
+  end
+end

data/lib/chromecast/channel/base.rb

@@ -0,0 +1,52 @@
+module Chromecast
+  module Channel
+    class Base
+      attr_accessor :connection, :namespace, :type
+
+      def initialize connection, namespace, type
+        self.connection = connection
+        self.namespace  = namespace
+        self.type       = type
+      end
+
+      def send data
+        #puts "SEND: #{data}"
+        #puts ""
+
+        msg = new_message(data)
+
+        encoded = msg.encode
+        size = [encoded.size].pack('N')
+
+        connection.write(size + encoded)
+
+        return nil
+      end
+
+      private
+
+      def new_message(payload)
+        m = Protocol::CastMessage.new
+
+        m.protocol_version = Protocol::CastMessage::ProtocolVersion::CASTV2_1_0
+        m.source_id = connection.source
+        m.destination_id = connection.destination
+        m.namespace = namespace
+
+        case type
+          when :json
+            m.payload_type = Protocol::CastMessage::PayloadType::STRING
+            m.payload_utf8 = payload.to_json
+          when :string
+            m.payload_type = Protocol::CastMessage::PayloadType::STRING
+            m.payload_utf8 = payload
+          when :binary
+            m.payload_type = Protocol::CastMessage::PayloadType::BINARY
+            m.payload_binary = payload
+        end
+
+        return m
+      end
+    end
+  end
+end

data/lib/chromecast/channel/connection.rb

@@ -0,0 +1,19 @@
+module Chromecast
+  module Channel
+    class Connection < Base
+      NAMESPACE = 'urn:x-cast:com.google.cast.tp.connection'
+      
+      def initialize connection
+        super(connection, NAMESPACE, :json)
+      end
+
+      def connect
+        send(type: 'CONNECT')
+      end
+
+      def close
+        send(type: 'CLOSE')
+      end
+    end
+  end
+end

data/lib/chromecast/channel/heartbeat.rb

@@ -0,0 +1,20 @@
+module Chromecast
+  module Channel
+    class Heartbeat < Base
+      NAMESPACE = 'urn:x-cast:com.google.cast.tp.heartbeat'
+      
+      def initialize connection
+        super(connection, NAMESPACE, :json)
+      end
+
+      def ping
+        send(type: 'PING')
+      end
+
+      def pong
+        send(type: 'PONG')
+      end
+    end
+  end
+end
+

data/lib/chromecast/channel/media.rb

@@ -0,0 +1,34 @@
+module Chromecast
+  module Channel
+    class Media < Base
+      NAMESPACE = 'urn:x-cast:com.google.cast.media'
+
+      def initialize connection
+        super(connection, NAMESPACE, :json)
+        @request_id = 0
+      end
+
+      def get_status
+        send(type: 'GET_STATUS')
+      end
+
+      def pause
+        send(type: 'PAUSE')
+      end
+
+      private
+
+      def next_request_id
+        @request_id += 1
+      end
+      
+      def send data
+        super(data.merge(
+          requestId: next_request_id,
+          mediaSessionId: '0B5C6066-F8B2-77F4-E5F1-8CEC223F0A22'
+        ))
+        @request_id
+      end
+    end
+  end
+end

data/lib/chromecast/channel/receiver.rb

@@ -0,0 +1,51 @@
+module Chromecast
+  module Channel
+    class Receiver < Base
+      NAMESPACE = 'urn:x-cast:com.google.cast.receiver'
+      
+      def initialize connection
+        super(connection, NAMESPACE, :json)
+        @request_id = 0
+      end
+
+      def launch app_id
+        send(type: 'LAUNCH', appId: app_id)
+      end
+
+      def stop session_id
+        send(type: 'STOP', sessionId: session_id)
+      end
+
+      def get_status
+        send(type: 'GET_STATUS')
+      end
+
+      def get_app_availability apps
+        send(type: 'GET_APP_AVAILABILITY', appId: [apps].flatten)
+      end
+
+      def set_volume level
+        send(type: 'SET_VOLUME', volume: {level: level})
+      end
+
+      def mute
+        send(type: 'SET_VOLUME', volume: {muted: true})
+      end
+
+      def unmute
+        send(type: 'SET_VOLUME', volume: {muted: false})
+      end
+
+      private
+
+      def next_request_id
+        @request_id += 1
+      end
+      
+      def send data
+        super(data.merge(requestId: next_request_id))
+        @request_id
+      end
+    end
+  end
+end

data/lib/chromecast/connection.rb

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'json'
+require 'socket'
+require 'openssl'
+
+module Chromecast
+  class Connection
+    DEFAULT_PORT          = 8009
+    DEFAULT_SOURCE        = 'source-0'
+    DEFAULT_DESTINATION   = 'receiver-0'
+
+    attr_reader :host, :port, :source, :destination, :socket
+    attr_accessor :key_file, :crt_file
+
+    def initialize(host)
+      @host         = host
+      @port         = DEFAULT_PORT
+      @source       = DEFAULT_SOURCE
+      @destination  = DEFAULT_DESTINATION
+      @key_file     = 'certificate.key'
+      @crt_file     = 'certificate.crt'
+    end
+
+    def certificate(type)
+      case type
+        when :crt
+          return File.open(crt_file).read
+        when :key
+          return File.open(key_file).read
+      end
+      return nil
+    end
+
+    def open
+      tcp = TCPSocket.new(host, port)
+      ctx = OpenSSL::SSL::SSLContext.new
+      ctx.cert = OpenSSL::X509::Certificate.new(certificate(:crt))
+      ctx.key = OpenSSL::PKey::RSA.new(certificate(:key))
+      ctx.ssl_version = :SSLv23
+      ctx.set_params(verify_mode: OpenSSL::SSL::VERIFY_NONE)
+
+      @socket = OpenSSL::SSL::SSLSocket.new(tcp, ctx).tap do |socket|
+        socket.sync_close = true
+        socket.connect
+      end
+
+      self
+    end
+
+    def write data
+      @socket.write data
+    end
+
+    def has_data?
+      ready = IO.select([@socket], nil, nil, 0)
+
+      return ready != nil
+    end
+
+    def read
+      return nil unless has_data?
+
+      resp_size = @socket.read(4).unpack('N').first
+      resp_data = @socket.read(resp_size)
+
+      resp = Protocol::CastMessage.decode(resp_data)
+
+      JSON.parse(resp.payload_utf8)
+    end
+
+    def connection
+      @connection_channel ||= Channel::Connection.new(self)
+    end
+
+    def receiver
+      @receiver_channel ||= Channel::Receiver.new(self)
+    end
+
+    def heartbeat
+      @heartbeat_channel ||= Channel::Heartbeat.new(self)
+    end
+
+    def media
+      @media_channel ||= Channel::Media.new(self)
+    end
+  end
+end

data/lib/chromecast/protocol.pb.rb

@@ -0,0 +1,68 @@
+##
+# This file is auto-generated. DO NOT EDIT!
+#
+require 'protobuf/message'
+
+module Chromecast
+  module Protocol
+
+    ##
+    # Message Classes
+    #
+    class CastMessage < ::Protobuf::Message
+      class ProtocolVersion < ::Protobuf::Enum
+        define :CASTV2_1_0, 0
+      end
+
+      class PayloadType < ::Protobuf::Enum
+        define :STRING, 0
+        define :BINARY, 1
+      end
+
+    end
+
+    class AuthChallenge < ::Protobuf::Message; end
+    class AuthResponse < ::Protobuf::Message; end
+    class AuthError < ::Protobuf::Message
+      class ErrorType < ::Protobuf::Enum
+        define :INTERNAL_ERROR, 0
+        define :NO_TLS, 1
+      end
+
+    end
+
+    class DeviceAuthMessage < ::Protobuf::Message; end
+
+
+    ##
+    # Message Fields
+    #
+    class CastMessage
+      required ::Chromecast::Protocol::CastMessage::ProtocolVersion, :protocol_version, 1
+      required :string, :source_id, 2
+      required :string, :destination_id, 3
+      required :string, :namespace, 4
+      required ::Chromecast::Protocol::CastMessage::PayloadType, :payload_type, 5
+      optional :string, :payload_utf8, 6
+      optional :bytes, :payload_binary, 7
+    end
+
+    class AuthResponse
+      required :bytes, :signature, 1
+      required :bytes, :client_auth_certificate, 2
+    end
+
+    class AuthError
+      required ::Chromecast::Protocol::AuthError::ErrorType, :error_type, 1
+    end
+
+    class DeviceAuthMessage
+      optional ::Chromecast::Protocol::AuthChallenge, :challenge, 1
+      optional ::Chromecast::Protocol::AuthResponse, :response, 2
+      optional ::Chromecast::Protocol::AuthError, :error, 3
+    end
+
+  end
+
+end
+

data/lib/chromecast/tasks.rb

@@ -0,0 +1,24 @@
+module Chromecast
+  class Tasks
+    include Rake::DSL if defined? Rake::DSL
+
+    def install_tasks
+      desc "Setup all necessary files"
+      task setup: ['setup:protocol', 'setup:certificate']
+
+      namespace :setup do
+        desc "Generate certificates for TLS"
+        task :certificate do
+          system('openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout certificate.key -out certificate.crt')
+        end
+
+        desc "Generate Ruby code for Chromecast protocol"
+        task :protocol do
+          system('protoc --ruby_out lib/chromecast/ protocol.proto && echo Generated protocol code')
+        end
+      end
+    end
+  end
+end
+
+Chromecast::Tasks.new.install_tasks

data/protocol.proto

@@ -0,0 +1,79 @@
+// Copyright 2013 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+syntax = "proto2";
+
+option optimize_for = LITE_RUNTIME;
+
+package Chromecast.Protocol;
+
+message CastMessage {
+  // Always pass a version of the protocol for future compatibility
+  // requirements.
+  enum ProtocolVersion {
+    CASTV2_1_0 = 0;
+  }
+  required ProtocolVersion protocol_version = 1;
+
+  // source and destination ids identify the origin and destination of the
+  // message.  They are used to route messages between endpoints that share a
+  // device-to-device channel.
+  //
+  // For messages between applications:
+  //   - The sender application id is a unique identifier generated on behalf of
+  //     the sender application.
+  //   - The receiver id is always the the session id for the application.
+  //
+  // For messages to or from the sender or receiver platform, the special ids
+  // 'sender-0' and 'receiver-0' can be used.
+  // 
+  // For messages intended for all endpoints using a given channel, the
+  // wildcard destination_id '*' can be used.
+  required string source_id = 2;
+  required string destination_id = 3;
+
+  // This is the core multiplexing key.  All messages are sent on a namespace
+  // and endpoints sharing a channel listen on one or more namespaces.  The
+  // namespace defines the protocol and semantics of the message.
+  required string namespace = 4;
+
+  // Encoding and payload info follows.
+
+  // What type of data do we have in this message.
+  enum PayloadType {
+    STRING = 0;
+    BINARY = 1;
+  }
+  required PayloadType payload_type = 5;
+
+  // Depending on payload_type, exactly one of the following optional fields
+  // will always be set.
+  optional string payload_utf8 = 6;
+  optional bytes payload_binary = 7;
+}
+
+// Messages for authentication protocol between a sender and a receiver.
+message AuthChallenge {
+}
+
+message AuthResponse {
+  required bytes signature = 1;
+  required bytes client_auth_certificate = 2;
+}
+
+message AuthError {
+  enum ErrorType {
+    INTERNAL_ERROR = 0;
+    NO_TLS = 1;  // The underlying connection is not TLS
+  }
+  required ErrorType error_type = 1;
+}
+
+message DeviceAuthMessage {
+  // Request fields
+  optional AuthChallenge challenge = 1;
+  // Response fields
+  optional AuthResponse response = 2;
+  optional AuthError error = 3;
+}

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: chromecast
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Robert Nasiadek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-tls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: The gem lets you monitor Chromecast status, control volume and launch
+  apps.
+email: robert@kapati.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rdoc
+- chromecast.gemspec
+- init.rb
+- lib/chromecast.rb
+- lib/chromecast/application.rb
+- lib/chromecast/channel.rb
+- lib/chromecast/channel/base.rb
+- lib/chromecast/channel/connection.rb
+- lib/chromecast/channel/heartbeat.rb
+- lib/chromecast/channel/media.rb
+- lib/chromecast/channel/receiver.rb
+- lib/chromecast/connection.rb
+- lib/chromecast/protocol.pb.rb
+- lib/chromecast/tasks.rb
+- protocol.proto
+homepage: http://robzon.pl/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Basic Chromecast controll via a Ruby library
+test_files: []