cine_io 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode

data/README.md

@@ -1,4 +1,6 @@
-# CineIo
+# cine.io ruby gem
+
+[![Build Status](https://travis-ci.org/cine-io/cineio-ruby.svg?branch=master)](https://travis-ci.org/cine-io/cineio-ruby)
 
 The ruby gem for [cine.io](cine.io).
 
@@ -18,7 +20,53 @@ Or install it yourself as:
 
 ## Usage
 
-Coming soon...
+### Initialization
+
+```ruby
+require('cine_io')
+client = CineIo::Client.new(secretKey: 'YOUR_SECRET_KEY')
+```
+
+### Methods
+
+#### Projects
+
+To get data about your project:
+
+```ruby
+project = client.project.get
+# => CineIo::Project
+```
+
+#### Streams
+
+To get all your streams:
+
+```ruby
+streams = client.streams.index
+# => [CineIo::Stream, …]
+```
+
+To get a specific stream:
+
+```ruby
+stream = client.streams.get('STREAM_ID')
+# => CineIo::Stream
+```
+
+To create a new stream:
+
+```ruby
+stream = client.streams.create
+# => CineIo::Stream
+```
+
+To fetch the [Flash Media Live Encoder](http://www.adobe.com/products/flash-media-encoder.html) profile for a stream:
+
+```ruby
+stream = client.streams.fmle_profile('STREAM_ID')
+# => String of profile contents
+```
 
 ## Contributing
 

data/cine_io.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = "cine_io"
   spec.version       = CineIo::VERSION
   spec.authors       = ["cine.io"]
-  spec.email         = ["support@cine.io"]
+  spec.email         = ["engineering@cine.io"]
   spec.description   = %q{cine.io is an api driven platform for creating and publish live streams. The provides cine.io functionality using your given public and secret keys.}
   spec.summary       = %q{The official cine.io ruby gem}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/cine-io/cineio-ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/cine_io/streams_handler.rb

@@ -8,6 +8,10 @@ class CineIo::StreamsHandler < CineIo::ResourceHandler
     CineIo::Stream.new get_resource("/stream", id: stream_id)
   end
 
+  def fmle_profile(stream_id)
+    get_resource("/stream", id: stream_id, fmleProfile: true).fetch('content')
+  end
+
   def create
     CineIo::Stream.new post_resource("/stream")
   end

data/lib/cine_io/version.rb

@@ -1,3 +1,3 @@
 module CineIo
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/cine_io/project_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe CineIo::Project do
 
-  subject { CineIo::Project.new(id: 'my id') }
+  subject { CineIo::Project.new(:id => 'my id') }
 
   it 'has some attributes' do
     expect(subject.id).to eq('my id')

data/spec/cine_io/projects_handler_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe CineIo::ProjectsHandler do
 
-  let(:client) { CineIo::Client.new(secretKey: "MY SECRET", publicKey: "MY PUBLIC") }
+  let(:client) { CineIo::Client.new(:secretKey => "MY SECRET", :publicKey => "MY PUBLIC") }
 
   subject { described_class.new(client) }
 

data/spec/cine_io/stream_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe CineIo::Stream do
 
-  subject { CineIo::Stream.new(id: 'my id') }
+  subject { CineIo::Stream.new(:id => 'my id') }
 
   it 'has some attributes' do
     expect(subject.id).to eq('my id')

data/spec/cine_io/streams_handler_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe CineIo::StreamsHandler do
 
-  let(:client) { CineIo::Client.new(secretKey: "MY SECRET", publicKey: "MY PUBLIC") }
+  let(:client) { CineIo::Client.new(:secretKey => "MY SECRET", :publicKey => "MY PUBLIC") }
 
   subject { described_class.new(client) }
 
@@ -25,6 +25,22 @@ describe CineIo::StreamsHandler do
     end
   end
 
+  describe '#fmle_profile' do
+    it "returns a fmle profile" do
+      VCR.use_cassette('get_fmle_profile') do
+        profile = subject.fmle_profile("537bee46bc03be080085a38a")
+        expect(profile).to be_a(String)
+        expect(profile).to include("flashmedialiveencoder_profile")
+      end
+    end
+
+    it 'can throw an error on api exception' do
+      VCR.use_cassette('get_fmle_profile_error', record: :once) do
+        expect {subject.get("NOT_AN_ID")}.to raise_error(CineIo::ApiError, "An unknown error has occured.")
+      end
+    end
+  end
+
   describe '#streams' do
     it "returns the streams" do
       VCR.use_cassette('get_streams') do

data/spec/cine_io_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 describe CineIo do
-  let(:client) { CineIo::Client.new(publicKey: 'My public key', secretKey: 'My secret key') }
+  let(:client) { CineIo::Client.new(:publicKey => 'My public key', :secretKey => 'My secret key') }
   subject { client }
 
   it 'takes a public and secret key' do
-    expect(subject.config).to eq(publicKey: 'My public key', secretKey: 'My secret key')
+    expect(subject.config).to eq(:publicKey => 'My public key', :secretKey => 'My secret key')
   end
   describe '#projects' do
     subject {client.project}

data/spec/fixtures/vcr_cassettes/get_fmle_profile.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.cine.io/api/1/-/stream?fmleProfile=true&id=537bee46bc03be080085a38a&secretKey=MY%20SECRET
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 03 Jun 2014 18:45:36 GMT
+      Etag:
+      - ! '"-1884831062"'
+      Set-Cookie:
+      - connect.sid=s%3AJaTfbZZFDtxLdRHfE5ASdnpH.czSW8SNkmM9Ax5Tk%2B2UV0iyvxLo%2BMZelXghmAkWkhJo;
+        Path=/; HttpOnly
+      Vary:
+      - Accept-Encoding
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '2330'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"content":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<flashmedialiveencoder_profile>THE PROFILE</flashmedialiveencoder_profile>\n"}'
+    http_version:
+  recorded_at: Tue, 03 Jun 2014 18:45:36 GMT
+recorded_with: VCR 2.3.0

data/spec/fixtures/vcr_cassettes/get_fmle_profile_error.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.cine.io/api/1/-/stream?id=NOT_AN_ID&secretKey=MY%20SECRET
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Content-Type:
+      - text/html; charset=utf-8
+      Date:
+      - Tue, 03 Jun 2014 18:47:08 GMT
+      Etag:
+      - ! '"-585839348"'
+      Set-Cookie:
+      - connect.sid=s%3AQHHKUGLaw40CPg3J6BFevR8U.PEqu3mFEqIf5v%2FVLr9DlaIWphceyM%2BSA1ZcNeDBOAJ0;
+        Path=/; HttpOnly
+      Vary:
+      - Accept-Encoding
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '29'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: An unknown error has occured.
+    http_version:
+  recorded_at: Tue, 03 Jun 2014 18:47:08 GMT
+recorded_with: VCR 2.3.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cine_io
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-01 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,12 +94,13 @@ dependencies:
 description: cine.io is an api driven platform for creating and publish live streams.
   The provides cine.io functionality using your given public and secret keys.
 email:
-- support@cine.io
+- engineering@cine.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -119,6 +120,8 @@ files:
 - spec/cine_io_spec.rb
 - spec/fixtures/vcr_cassettes/create_stream.yml
 - spec/fixtures/vcr_cassettes/create_stream_error.yml
+- spec/fixtures/vcr_cassettes/get_fmle_profile.yml
+- spec/fixtures/vcr_cassettes/get_fmle_profile_error.yml
 - spec/fixtures/vcr_cassettes/get_project.yml
 - spec/fixtures/vcr_cassettes/get_project_error.yml
 - spec/fixtures/vcr_cassettes/get_stream.yml
@@ -126,7 +129,7 @@ files:
 - spec/fixtures/vcr_cassettes/get_streams.yml
 - spec/fixtures/vcr_cassettes/get_streams_error.yml
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/cine-io/cineio-ruby
 licenses:
 - MIT
 post_install_message: 
@@ -159,6 +162,8 @@ test_files:
 - spec/cine_io_spec.rb
 - spec/fixtures/vcr_cassettes/create_stream.yml
 - spec/fixtures/vcr_cassettes/create_stream_error.yml
+- spec/fixtures/vcr_cassettes/get_fmle_profile.yml
+- spec/fixtures/vcr_cassettes/get_fmle_profile_error.yml
 - spec/fixtures/vcr_cassettes/get_project.yml
 - spec/fixtures/vcr_cassettes/get_project_error.yml
 - spec/fixtures/vcr_cassettes/get_stream.yml