cine_io 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a37c24dc5ba3033b57e53be1b0b641b58ae2aa1e
-  data.tar.gz: 4eea038909835278e264b92ca422818c51ae2eb9
+  metadata.gz: 528e5a1955d49b0a66e7c72df42a6d2e4d9ab568
+  data.tar.gz: 99728496117f2929001f8d711620d843bc6c0f03
 SHA512:
-  metadata.gz: f8d039ce91e1f079d1ba5d82b331efa83ad699d218b17de137de328fbe599e541a8e21daa2ec674665e13f17da76e500fddbb037f67facf4d2bcdf6971445f2b
-  data.tar.gz: 9c1b0b310548b02714305920f6c6abd9eb6cc4706b7f3fbdd23f0a67936d97fead5ec75bda322580e8bf86e732b301ba3139d2213245b34edafb00ce80bd28c1
+  metadata.gz: 9d8f1a68944bd0a590638f2b909eda3b58328a13c21d45c364bed5d1b16e7d79f46a208981ec7a033b3b4cc334b86ee989f7d0b5a0624be9d7fec7ef862d41e5
+  data.tar.gz: e6014ebf70ae7e1770d2055ea1f19caec3a28cc571f89878c554c4b4346eaee13da161fb0e92d0ede988ad4b9108d5fb40733dc52e66082ad221b3165d09605c

data/README.md

@@ -135,9 +135,33 @@ recordings = client.streams.recordings.delete('STREAM_ID', 'recordingName')
 #### Identity Signature Generation
 
 ```ruby
-var identity = "Unique user name to your app"
+identity = "Unique user name to your app"
 response = client.peer.generate_identity_signature(identity)
-// response looks like {signature: "sha1-hash", timestamp: 1420258111, identity: "Unique user name to your app"}
+# response looks like {signature: "sha1-hash", timestamp: 1420258111, identity: "Unique user name to your app"}
+```
+
+
+### Usage
+
+Use these api endpoints to fetch the monthly usage for a project or a stream.
+
+#### Project Usage
+
+```ruby
+options = {:month => new Date, :report => ['bandwidth, 'peer']}
+response = client.usage.project(options)
+// response looks like {bandwidth: 12345, storage: 54321, month: "month (ISO 8601 format)", secretKey: "YOUR SECRET KEY"}
+// bandwidth and storage are represented in bytes
+```
+
+#### Stream Usage
+
+```ruby
+id = 'STREAM_ID'
+options = {:month => new Date, :report => ['bandwidth, 'peer']}
+response = client.usage.stream(id, options);
+// response looks like {bandwidth: 12345, storage: 54321, month: "month (ISO 8601 format)", secretKey: "YOUR SECRET KEY", id: "STREAM_ID"}
+// bandwidth and storage are represented in bytes
 ```
 
 ## Contributing

data/cine_io.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "queryparams", "~> 0.0.3"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", '~> 10.3.0'
   spec.add_development_dependency "rspec", '~> 3.0.0'

data/lib/cine_io.rb

@@ -32,5 +32,9 @@ module CineIo
       @peer ||= CineIo::Peer.new(self)
     end
 
+    def usage
+      @usage ||= CineIo::UsageHandler.new(self)
+    end
+
   end
 end

data/lib/cine_io/resource_handler.rb

@@ -1,3 +1,5 @@
+require('queryparams')
+
 class CineIo::ResourceHandler
 
   protected
@@ -10,7 +12,7 @@ class CineIo::ResourceHandler
 
   def get_resource(path, params={})
     uri = URI.parse("#{CineIo::BASE_URL}#{path}")
-    uri.query = URI.encode_www_form({:secretKey => @client.config.fetch(:secretKey)}.merge(params))
+    uri.query = QueryParams.encode({:secretKey => @client.config.fetch(:secretKey)}.merge(params))
     http = Net::HTTP.new(uri.host, uri.port)
     http.use_ssl = (uri.scheme == "https")
 
@@ -23,7 +25,7 @@ class CineIo::ResourceHandler
 
   def get_resource_with_master_key(path, params={})
     uri = URI.parse("#{CineIo::BASE_URL}#{path}")
-    uri.query = URI.encode_www_form({:masterKey => @client.config.fetch(:masterKey)}.merge(params))
+    uri.query = QueryParams.encode({:masterKey => @client.config.fetch(:masterKey)}.merge(params))
     http = Net::HTTP.new(uri.host, uri.port)
     http.use_ssl = (uri.scheme == "https")
 

data/lib/cine_io/usage_handler.rb

@@ -0,0 +1,22 @@
+require 'time'
+
+class CineIo::UsageHandler < CineIo::ResourceHandler
+
+  def project(options)
+    params = {
+      :month => options.fetch(:month).utc.iso8601,
+      :report => options.fetch(:report)
+    }
+    get_resource("/usage/project", params)
+  end
+
+  def stream(id, options)
+    params = {
+      :month => options.fetch(:month).utc.iso8601,
+      :report => options.fetch(:report),
+      :id => id
+    }
+    get_resource("/usage/stream", params)
+  end
+
+end

data/lib/cine_io/version.rb

@@ -1,3 +1,3 @@
 module CineIo
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/spec/cine_io/peer_spec.rb

@@ -12,7 +12,7 @@ describe CineIo::Peer do
       time = Time.parse("Jan 2 2015")
       allow(Time).to receive(:now) { time }
 
-      expect(subject.generate_identity_signature('Thomas')).to eq(identity: "Thomas", signature: "6fbb691889a3db90f6be439aaaaebfca50f1e94d", timestamp: 1420185600)
+      expect(subject.generate_identity_signature('Thomas')).to eq(identity: "Thomas", signature: "604d94e08118b3539d12d9394fc5c0e27f9959dc", timestamp: 1420156800)
     end
   end
 

data/spec/cine_io/usage_handler_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe CineIo::UsageHandler do
+
+  let(:client) { CineIo::Client.new(:secretKey => "THE PROJECT SECRET KEY") }
+
+  subject { described_class.new(client) }
+
+  describe '#project' do
+    it "returns the project usage report" do
+      time = Time.parse("January 06 2015")
+      VCR.use_cassette('usage_project') do
+        options = {:month => time, :report => ['bandwidth', 'storage']}
+        result = subject.project(options)
+
+        expect(result["secretKey"]).to eq('THE PROJECT SECRET KEY')
+        expect(result["bandwidth"]).to eq(1073741824)
+        expect(result["storage"]).to eq(2147483648)
+        expect(result["month"]).to eq("2015-01-06T00:00:00.000Z")
+      end
+    end
+  end
+
+  describe '#stream' do
+    it "returns the stream usage report" do
+      time = Time.parse("January 06 2015")
+      VCR.use_cassette('usage_stream') do
+        id = "THE STREAM ID"
+        options = {:month => time, :report => ['bandwidth', 'storage']}
+        result = subject.stream(id, options)
+
+        expect(result["id"]).to eq('THE STREAM ID')
+        expect(result["secretKey"]).to eq('THE PROJECT SECRET KEY')
+        expect(result["bandwidth"]).to eq(1073741824)
+        expect(result["storage"]).to eq(2147483648)
+        expect(result["month"]).to eq("2015-01-06T00:00:00.000Z")
+      end
+    end
+  end
+
+end

data/spec/cine_io_spec.rb

@@ -28,4 +28,9 @@ describe CineIo do
     it { should be_a(CineIo::Peer) }
   end
 
+  describe '#usage' do
+    subject {client.usage}
+    it { should be_a(CineIo::UsageHandler) }
+  end
+
 end

data/spec/fixtures/vcr_cassettes/usage_project.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.cine.io/api/1/-/usage/project?month=2015-01-06T00:00:00Z&report%5B0%5D=bandwidth&report%5B1%5D=storage&secretKey=THE%20PROJECT%20SECRET%20KEY
+    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:
+      - Sun, 01 Jun 2014 07:27:53 GMT
+      Etag:
+      - ! '"-585713471"'
+      Set-Cookie:
+      - connect.sid=s%3ACxr5WVK6KEkFqdcFxxYTSTJ7.%2F7TTnVJK4mHsI%2FAIiKiebpUq5y5d5Fz8MmK7Azhad%2Bg;
+        Path=/; HttpOnly
+      Vary:
+      - Accept-Encoding
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '217'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"secretKey": "THE PROJECT SECRET KEY", "month": "2015-01-06T00:00:00.000Z", "bandwidth": 1073741824, "storage": 2147483648 }'
+    http_version:
+  recorded_at: Sun, 01 Jun 2014 07:27:53 GMT
+recorded_with: VCR 2.3.0

data/spec/fixtures/vcr_cassettes/usage_stream.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.cine.io/api/1/-/usage/stream?id=THE%20STREAM%20ID&month=2015-01-06T00:00:00Z&report%5B0%5D=bandwidth&report%5B1%5D=storage&secretKey=THE%20PROJECT%20SECRET%20KEY
+    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:
+      - Sun, 01 Jun 2014 07:27:53 GMT
+      Etag:
+      - ! '"-585713471"'
+      Set-Cookie:
+      - connect.sid=s%3ACxr5WVK6KEkFqdcFxxYTSTJ7.%2F7TTnVJK4mHsI%2FAIiKiebpUq5y5d5Fz8MmK7Azhad%2Bg;
+        Path=/; HttpOnly
+      Vary:
+      - Accept-Encoding
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '217'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"id": "THE STREAM ID", "secretKey": "THE PROJECT SECRET KEY", "month": "2015-01-06T00:00:00.000Z", "bandwidth": 1073741824, "storage": 2147483648 }'
+    http_version:
+  recorded_at: Sun, 01 Jun 2014 07:27:53 GMT
+recorded_with: VCR 2.3.0

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+ENV['TZ'] = 'UTC'
+
 require 'cine_io'
 require 'vcr'
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cine_io
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - cine.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: queryparams
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +119,7 @@ files:
 - lib/cine_io/stream_recording.rb
 - lib/cine_io/stream_recordings_handler.rb
 - lib/cine_io/streams_handler.rb
+- lib/cine_io/usage_handler.rb
 - lib/cine_io/version.rb
 - spec/cine_io/peer_spec.rb
 - spec/cine_io/project_handler_spec.rb
@@ -114,6 +129,7 @@ files:
 - spec/cine_io/stream_recordings_handler_spec.rb
 - spec/cine_io/stream_spec.rb
 - spec/cine_io/streams_handler_spec.rb
+- spec/cine_io/usage_handler_spec.rb
 - spec/cine_io_spec.rb
 - spec/fixtures/vcr_cassettes/create_stream.yml
 - spec/fixtures/vcr_cassettes/create_stream_error.yml
@@ -142,6 +158,8 @@ files:
 - spec/fixtures/vcr_cassettes/update_project_error.yml
 - spec/fixtures/vcr_cassettes/update_stream.yml
 - spec/fixtures/vcr_cassettes/update_stream_error.yml
+- spec/fixtures/vcr_cassettes/usage_project.yml
+- spec/fixtures/vcr_cassettes/usage_stream.yml
 - spec/spec_helper.rb
 homepage: https://github.com/cine-io/cineio-ruby
 licenses:
@@ -176,6 +194,7 @@ test_files:
 - spec/cine_io/stream_recordings_handler_spec.rb
 - spec/cine_io/stream_spec.rb
 - spec/cine_io/streams_handler_spec.rb
+- spec/cine_io/usage_handler_spec.rb
 - spec/cine_io_spec.rb
 - spec/fixtures/vcr_cassettes/create_stream.yml
 - spec/fixtures/vcr_cassettes/create_stream_error.yml
@@ -204,4 +223,6 @@ test_files:
 - spec/fixtures/vcr_cassettes/update_project_error.yml
 - spec/fixtures/vcr_cassettes/update_stream.yml
 - spec/fixtures/vcr_cassettes/update_stream_error.yml
+- spec/fixtures/vcr_cassettes/usage_project.yml
+- spec/fixtures/vcr_cassettes/usage_stream.yml
 - spec/spec_helper.rb