jani-converter_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 741071a1526337bd0dbd9400a746a37b7637c628
+  data.tar.gz: 5d652dda02f7795515eab6d397ef4d9ea0cb0c3b
+SHA512:
+  metadata.gz: d68b4609fc0748a69387162dc8eeeba8016ef4abdcfec3060ca068f47b48717ca4040973fc3657e6c20d0fc3a463b22966a1c6239ed0546b527acba7e1eb2c7a
+  data.tar.gz: ee5925bccdc1b9981941f526889104a7fe1b6ac79c8565b274de12492452c00eacb4567a880a585a5cf4707ecd2e2b0c0c7cf2a29a6934f9643a2e534c5c67aa

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jani-converter_client.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", require: nil
+
+unless ENV["CI"]
+  gem 'guard-rspec', require: false
+end

data/Guardfile

@@ -0,0 +1,17 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Shin'ichi Ohno
+
+MIT License
+
+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,67 @@
+# Jani::ConverterClient
+
+API client for jani-converter.
+Implemented as a thin layer on top of faraday.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jani-converter_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jani-converter_client
+
+## Usage
+
+```ruby
+require "jani/converter_client"
+conn = Jani::ConverterClient.new(base_url: "http://localhost:3000/movies")
+response = conn.get_movie("43c76def-6ba6-44cf-9899-4311cb877d07")
+response.movie.uuid #=> 43c76def-6ba6-44cf-9899-4311cb877d07
+response.status #=> 200
+
+response = conn.post_movie(
+    {
+      fps: fps,
+      frame_height: frame_height,
+      frame_width: frame_width,
+      remote_movie_url: "https://example.com/video.mp4",
+      postroll_banner: {
+        url: banner_link_url,
+        remote_image_url: "http://example.com/banner_1.jpg",
+      },
+      loading_banner: {
+        remote_image_url: "http://example.com/banner_2.jpg",
+      },
+      tracking_events: {
+        foo: {
+          label: tracking_event_label,
+          url: tracking_event_url,
+          request_type: tracking_event_request_type,
+        },
+      }
+    },
+    callback_url: "http://localhost:3000/encode_complete_callback"
+  )
+
+response.status #=> 201: created
+response.movie.uuid #=> server generates uuid and returns it
+response.movie.fps #=> fps
+# other attributes...
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/shin1ohno/jani-converter_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/jani-converter_client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jani/converter_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jani-converter_client"
+  spec.version       = Jani::ConverterClient::VERSION
+  spec.authors       = ["Shin'ichi Ohno"]
+  spec.email         = ["shin1ohno@me.com"]
+  spec.summary       = %q{API client for jani-converter.}
+  spec.description   = %q{API client for jani-converter.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "jani-from_json"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-collection_matchers"
+end

data/lib/jani/converter_client.rb

@@ -0,0 +1,14 @@
+require "jani/converter_client/version"
+require "jani/converter_client/connection"
+
+module Jani
+  module ConverterClient
+    class << self
+      def new(base_url: base_url)
+        return unless base_url
+        @base_url = base_url
+        Jani::ConverterClient::Connection.new(base_url)
+      end
+    end
+  end
+end

data/lib/jani/converter_client/connection.rb

@@ -0,0 +1,40 @@
+require "jani/from_json"
+require "jani/converter_client/response"
+require "faraday"
+
+class Jani::ConverterClient::Connection
+  def initialize(base_url)
+    @base_url = base_url
+  end
+
+  def get_movie(uuid)
+    Jani::ConverterClient::Response.new(
+      connection.get("uuid/#{uuid}.json")
+    )
+  end
+
+  def post_movie(movie_data: movie_data, callback_url: callback_url)
+    Jani::ConverterClient::Response.new(
+      connection.post() do |req|
+        req.url "#{@base_url}.json"
+        req.headers['Content-Type'] = 'application/json'
+        req.body = {
+          movie: {
+            fps: movie_data[:fps],
+            frame_height: movie_data[:frame_height],
+            frame_width: movie_data[:frame_width],
+            remote_movie_url: movie_data[:remote_movie_url],
+            postroll_banner_attributes: movie_data[:postroll_banner],
+            loading_banner_attributes: movie_data[:loading_banner],
+            tracking_events: movie_data[:tracking_events],
+          },
+          callback_url: callback_url
+        }.to_json
+      end
+    )
+  end
+
+  def connection
+    @connection ||= Faraday.new(url: @base_url)
+  end
+end

data/lib/jani/converter_client/response.rb

@@ -0,0 +1,18 @@
+require "forwardable"
+require "jani/from_json"
+
+class Jani::ConverterClient::Response
+  extend Forwardable
+  attr_reader :movie
+  def_delegators :@http_response, :status, :headers, :body, :success?
+
+  def initialize(http_response)
+    @http_response = http_response
+
+    @movie = if success?
+      Jani::FromJson.to_movie(http_response.body)
+    else
+      Jani::FromJson.empty_movie
+    end
+  end
+end

data/lib/jani/converter_client/version.rb

@@ -0,0 +1,5 @@
+module Jani
+  module ConverterClient
+    VERSION = "1.0.0"
+  end
+end

data/spec/jani/converter_client/connection_spec.rb

@@ -0,0 +1,104 @@
+require "jani/converter_client/connection"
+
+RSpec.describe Jani::ConverterClient::Connection do
+  let(:connection) { Jani::ConverterClient::Connection.new("http://localhost:3000/movies") }
+
+  describe "#get_movie" do
+    subject(:response) { connection.get_movie(uuid) }
+
+    context "given valid uuid" do
+      let(:uuid) { "ed92fded-d1fe-4cc8-a254-032015eb25a0" }
+
+      it "returns the movie" do
+        is_expected.to be_success
+        expect(response.movie.uuid).to eq uuid
+      end
+    end
+
+    context "given non existing uuid" do
+      let(:uuid) { "a" }
+
+      it "returns empty movie" do
+        is_expected.not_to be_success
+        expect(response.status).to eq 404
+        expect(response.movie.uuid).to be_nil
+      end
+    end
+
+    context "given no uuid" do
+      let(:uuid) { nil }
+
+      it "returns empty movie" do
+        is_expected.not_to be_success
+        expect(response.status).to eq 404
+        expect(response.movie.uuid).to be_nil
+      end
+    end
+  end
+
+  describe "#post_movie" do
+    subject(:response) { connection.post_movie(movie_data: movie_data, callback_url: callback_url)  }
+    let(:callback_url) { "http://localhost:3000/encode_complete_callback" }
+
+    context "given nil movie data" do
+      let(:movie_data) { nil }
+
+      it "returns the empty movie" do
+        is_expected.not_to be_success
+        expect(response.status).to eq 400
+        expect(response.movie.uuid).to be_nil
+      end
+    end
+
+    context "given valid movie data" do
+      let(:movie_data) do
+        {
+          fps: fps,
+          frame_height: frame_height,
+          frame_width: frame_width,
+          remote_movie_url: "http://example.com/video.mp4",
+          postroll_banner: {
+            url: banner_link_url,
+            remote_image_url: "http://example.com/frame0019.jpg",
+          },
+          loading_banner: {
+            remote_image_url: "http://example.com/frame0467.jpg",
+          },
+          tracking_events: {
+            foo: {
+              label: tracking_event_label,
+              url: tracking_event_url,
+              request_type: tracking_event_request_type,
+            },
+          }
+        }
+      end
+
+      let(:fps) { 30 }
+      let(:frame_width) { 640 }
+      let(:frame_height) { 360 }
+      let(:banner_link_url) { "http://example.com/?postroll" }
+      let(:tracking_event_url) { "/foo" }
+      let(:tracking_event_label) { "/foo" }
+      let(:tracking_event_request_type) { "xhr" }
+
+      it "returns created movie" do
+        is_expected.to be_success
+        expect(response.status).to eq 201
+        expect(response.movie.uuid).not_to be_nil
+        expect(response.movie.fps).to eq fps
+        expect(response.movie.frame_width).to eq frame_width
+        expect(response.movie.frame_height).to eq frame_height
+
+        expect(response.movie.loading_banner.image_url).to end_with "frame0467.jpg"
+
+        expect(response.movie.postroll_banner.image_url).to end_with "frame0019.jpg"
+        expect(response.movie.postroll_banner.url).to eq banner_link_url
+
+        expect(response.movie.tracking_events[0].label).to eq tracking_event_label
+        expect(response.movie.tracking_events[0].request_type).to eq tracking_event_request_type
+        expect(response.movie.tracking_events[0].url).to eq tracking_event_url
+      end
+    end
+  end
+end

data/spec/jani/converter_client_spec.rb

@@ -0,0 +1,12 @@
+require "jani/converter_client"
+require "faraday"
+
+RSpec.describe Jani::ConverterClient do
+  describe ".new" do
+    subject { Jani::ConverterClient.new(base_url: "http://localhost:3000/movies/") }
+
+    it "returns connection" do
+      is_expected.to be_a_kind_of Jani::ConverterClient::Connection
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require 'rspec/collection_matchers'
+require "codeclimate-test-reporter"
+
+if ENV["CI"]
+  CodeClimate::TestReporter.start
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: jani-converter_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shin'ichi Ohno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jani-from_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API client for jani-converter.
+email:
+- shin1ohno@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jani-converter_client.gemspec
+- lib/jani/converter_client.rb
+- lib/jani/converter_client/connection.rb
+- lib/jani/converter_client/response.rb
+- lib/jani/converter_client/version.rb
+- spec/jani/converter_client/connection_spec.rb
+- spec/jani/converter_client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.4.2
+signing_key: 
+specification_version: 4
+summary: API client for jani-converter.
+test_files:
+- spec/jani/converter_client/connection_spec.rb
+- spec/jani/converter_client_spec.rb
+- spec/spec_helper.rb