jwplayer-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8e059510251aba539bab5f51b2fcbc3d9b85498
+  data.tar.gz: 8c9eece592fa5fd99af7cfd319f09fb6ecccc56d
+SHA512:
+  metadata.gz: 7c8b185574284531005bd311b5efefab08ca3136550fa2dd689ed4250aa3b2129e644f17a8c37d66ddc39a5778372e71bf6c735d47afe323987637ec41176c82
+  data.tar.gz: 6677eff90b196e735326a6cffcc991d427b4d1b6d8b564bf751f2e071102092bf544882efe7e0f36dbc65cdfac5259c0131f6b07838a52dab1ff68fa548783c3

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.idea/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jwplayer-api-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 raphi
+
+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

@@ -0,0 +1,108 @@
+# JWPlayer::API::Client
+
+This gem aims to easily sign JWPlayer Platform API URLs according to the documentation: https://developer.jwplayer.com/jw-platform/reference/v1/authentication.html
+It is not intended to actually send the request but simply to generate the correctly signed URL. An example at the end of this documentation is provided though.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jwplayer-api-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jwplayer-api-client
+
+## Usage
+
+To get started, instantiate a new client:
+
+```ruby
+irb> client = JWPlayer::API::Client.new(key: 'y0c6CFQ5', secret: 'YZWQ1SfmpFYEfW9kiR1QerRF')
+=> #<JWPlayer::API::Client:0x007fb6909e0158 @options={:host=>"api.jwplatform.com", :scheme=>"https", :version=>:v1, :key=>"y0c6CFQ5", :secret=>"YZWQ1SfmpFYEfW9kiR1QerRF", :format=>:json}>
+```
+
+If you have previously set `JWPLAYER_API_KEY` and `JWPLAYER_API_SECRET` ENV variables, you can simply do:
+ 
+```ruby
+irb> client = JWPlayer::API::Client.new
+=> #<JWPlayer::API::Client:0x007fb6909e0158 @options={:host=>"api.jwplatform.com", :scheme=>"https", :version=>:v1, :key=>"y0c6CFQ5", :secret=>"YZWQ1SfmpFYEfW9kiR1QerRF", :format=>:json}>
+```
+
+`JWPlayer::API::Client.new()` accepts the following optional parameters:
+
+| Name      | Default                               | Description |
+|-----------|---------------------------------------|-------------| 
+| key       | ENV['JWPLAYER_API_KEY']               | JWPlayer Platform API key
+| secret    | ENV['JWPLAYER_API_SECRET']            | JWPlayer Platform API secret
+| host      | 'api.jwplatform.com'                  | API host
+| scheme    | 'https'                               | API scheme
+| version   | :v1                                   | API version
+| format    | :json                                 | API response format
+| timestamp | current time                          | API UNIX timestamp used against replay-attacks
+| nonce     | automatically generated for each call | 8 digit random number
+See https://developer.jwplayer.com/jw-platform/reference/v1/call_syntax.html for more information.
+
+Then, you can get a signed uri or signed url like this:
+
+```ruby
+irb> client.signed_uri('videos/create')
+=> #<URI::Generic https://api.jwplatform.com/v1/videos/create?api_format=json&api_key=y0c6CFQ5&api_nonce=36581160&api_signature=95c92965a690119b086e40e37c2bb9d9ef6d3781&api_timestamp=1462808317>
+
+irb> client.signed_url('videos/create')
+=> "https://api.jwplatform.com/v1/videos/create?api_format=json&api_key=y0c6CFQ5&api_nonce=36581160&api_signature=95c92965a690119b086e40e37c2bb9d9ef6d3781&api_timestamp=1462808317"
+```
+
+And with query parameters:
+
+```ruby
+irb> client.signed_url('videos/create', title: 'My Super Video', description: 'This is cool')
+=> "https://api.jwplatform.com/v1/videos/create?api_format=json&api_key=y0b9GFQ3&api_nonce=36581160&api_signature=4b2e1d7c6aeda3c87e634300563159a5ba99b661&api_timestamp=1462808317&description=This%20is%20cool&title=My%20Super%20Video"
+```
+
+### IRL example
+
+Create a video reference in your JWPlayer Dashboard and get the `media_id`:
+
+```ruby
+require 'typhoeus'
+
+data = {
+  author:        'Raphaël',
+  date:          Date.new(2002,03,04).to_time.to_i,
+  description:   'Yet Another Keynote',
+  title:         'Apple Keynote',
+  source_format: :m3u8,
+  source_type:   :url,
+  source_url:    'http://qthttp.apple.com.edgesuite.net/1010qwoeiuryfg/sl.m3u8'
+}
+
+# Call JWPlayer /videos/create API https://developer.jwplayer.com/jw-platform/reference/v1/methods/videos/create.html
+jw_client  = JWPlayer::API::Client.new
+signed_url = jw_client.signed_url('videos/create', data)
+response   = Typhoeus.post(signed_url)
+json       = JSON.parse(response.body)
+media_id   = json.dig('media', 'key')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/raphi/jwplayer-api-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'jwplayer/api/client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jwplayer-api-client.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jwplayer/api/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jwplayer-api-client'
+  spec.version       = JWPlayer::API::Client::VERSION
+  spec.authors       = ['Raphael Daguenet']
+  spec.email         = ['raphael.daguenet@gmail.com']
+
+  spec.summary       = 'JWPlayer client to easily sign URLs'
+  spec.description   = 'This gem aims to easily sign JWPlayer Platform API URLs according to the documentation: https://developer.jwplayer.com/jw-platform/reference/v1/authentication.html'
+  spec.homepage      = 'https://github.com/raphi/jwplayer-api-client'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/jwplayer/api/client.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'digest'
+require 'jwplayer/api/client/version'
+
+module JWPlayer
+  module API
+    class Client
+      ALLOWED_KEYS = [:format, :key, :nonce, :timestamp]
+      IGNORED_KEYS = [:host, :scheme, :secret, :signature, :version]
+      ESCAPE_REGEX = /[^a-z0-9\-\.\_\~]/i # http://oauth.net/core/1.0/#encoding_parameters
+
+      attr_reader :params, :options
+
+      def initialize(args = {})
+        @options = {
+            host:    'api.jwplatform.com',
+            scheme:  'https',
+            version: :v1,
+            key:     ENV['JWPLAYER_API_KEY'],
+            secret:  ENV['JWPLAYER_API_SECRET'],
+            format:  :json
+        }.merge(args)
+
+        [:key, :secret].each do |key|
+          if options[key].nil? || options[key].empty?
+            raise ArgumentError, "Missing :#{key} parameter or 'JWPLAYER_API_#{key.upcase}' ENV variable"
+          end
+        end
+      end
+
+      def signed_uri(path, params = {})
+        @params              = params
+        @options[:nonce]     = rand.to_s[2..9]
+        @options[:timestamp] = Time.now.to_i.to_s
+        @uri                 = URI.join(URI::Generic.build(@options), [@options[:version], '/'].join, path)
+        @uri.query           = signed_attributes
+        @uri.normalize!
+        @uri
+      end
+
+      def signed_url(path, params = {})
+        signed_uri(path, params).to_s
+      end
+
+      private
+
+      #
+      # API signature generation
+      # https://developer.jwplayer.com/jw-platform/reference/v1/authentication.html#api-signature-generation
+      #
+
+      def attributes
+        matching_keys, extra_keys = options.keys.partition { |key| ALLOWED_KEYS.include?(key) }
+        extra_keys                -= IGNORED_KEYS
+
+        raise ArgumentError, "#{self.class}: Unknown extra option keys\n [#{extra_keys.map(&:inspect).join(', ')}]" unless extra_keys.empty?
+
+        matching_keys.map { |key| [:"api_#{key}", options[key]] }
+      end
+
+      def signed_attributes
+        salted_params = salted_params(normalized_params)
+        signature     = signature(salted_params)
+
+        to_query((params.to_a + attributes.to_a).push([:api_signature, signature]))
+      end
+
+      def normalized_params
+        to_query(signature_params)
+      end
+
+      def signature_params
+        sorted_params(params.to_a + attributes.to_a)
+      end
+
+      #
+      # Steps 1 and 2
+      # 1. All text parameters converted to UTF-8 encoding
+      # 2. All text parameters URL-encoded
+      #
+      def escape(value)
+        URI.escape(value.to_s, ESCAPE_REGEX)
+      end
+
+      #
+      # Step 3
+      # 3. Parameters are sorted based on their encoded names. Sort order is lexicographical byte value ordering
+      #
+      def sorted_params(params)
+        params.sort
+      end
+
+      #
+      # Step 4
+      # 4. Parameters are concatenated together into a single query string
+      #
+      def to_query(params)
+        params.map { |key, value| [key, escape(value)].join('=') }.join('&')
+      end
+
+      #
+      # Step 5
+      # The secret is added and SHA-1 digest is calculated
+      # Secret is added to the end of the SBS
+      #
+      def salted_params(query_string)
+        query_string + options[:secret].to_s
+      end
+
+      #
+      # Step 6
+      # The calculated SHA-1 HEX digest
+      #
+      def signature(token)
+        Digest::SHA1.hexdigest(token)
+      end
+    end
+  end
+end

data/lib/jwplayer/api/client/version.rb

@@ -0,0 +1,7 @@
+module JWPlayer
+  module API
+    class Client
+      VERSION = '0.1.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: jwplayer-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Raphael Daguenet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'This gem aims to easily sign JWPlayer Platform API URLs according to
+  the documentation: https://developer.jwplayer.com/jw-platform/reference/v1/authentication.html'
+email:
+- raphael.daguenet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jwplayer-api-client.gemspec
+- lib/jwplayer/api/client.rb
+- lib/jwplayer/api/client/version.rb
+homepage: https://github.com/raphi/jwplayer-api-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: JWPlayer client to easily sign URLs
+test_files: []