kinescope-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3fb5f95e53be2059c94bbad909351d31f416b85229f4819fe850bbbe78e87071
+  data.tar.gz: 3fca2049e2478bd6616ddf6cd947aaa54d9a2df322623009f4db79544b4828ab
+SHA512:
+  metadata.gz: af637af6bd71720d97c5107f2c870890bf61e6499f1ac346e45dff6619a6d8b5736c6297cb63fcfdd719c50524cbfa954d490dc57c0c6b13152144618d8d454e
+  data.tar.gz: df03cb79f5a3cc44a3d97db6530930682d5ba4636f109987ee1b9490c81550104a0c9e3730f0955ea6ec1bc19699923ab42023647581d91d486d3085d1b2464f

data/.gitignore

@@ -0,0 +1,14 @@
+.DS_Store
+Gemfile.lock
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format progress
+--require pry
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'simplecov', '~> 0.17.0'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 droff
+
+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,43 @@
+# Kinescope::Rb
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kinescope/rb`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kinescope-rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kinescope-rb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/kinescope-rb. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Kinescope::Rb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/kinescope-rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'irb'
+require 'kinescope'
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/kinescope-rb.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kinescope/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kinescope-rb'
+  spec.version       = Kinescope::VERSION
+  spec.authors       = ['droff']
+  spec.email         = ['adroff@gmail.com']
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/droff/kinescope-rb'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # 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.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'kartograph', '~> 0.2.3'
+  spec.add_dependency 'resource_kit', '~> 0.1.5'
+  spec.add_dependency 'virtus', '~> 1.0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.8.0'
+end

data/lib/kinescope/client.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Kinescope
+  class Client
+    DEFAULT_API_URL = 'https://api.kinescope.io'.freeze
+    DEFAULT_TIMEOUT = 120
+    DEFAULT_OPEN_TIMEOUT = 60
+
+    attr_reader :access_token, :api_url, :open_timeout, :timeout, :user_agent
+
+    def initialize(options = {})
+      @access_token = options[:access_token]
+      @api_url = options[:api_url] || DEFAULT_API_URL
+      @open_timeout = options[:open_timeout] || DEFAULT_OPEN_TIMEOUT
+      @timeout = options[:timeout] || DEFAULT_TIMEOUT
+      @user_agent = options[:user_agent]
+    end
+
+    def connection
+      @connection ||= Faraday.new(connection_options) do |req|
+        req.adapter :net_http
+        req.options.timeout = timeout
+        req.options.open_timeout = open_timeout
+      end
+    end
+
+    def self.resources
+      {
+        videos: VideoResource,
+      }
+    end
+
+    def resources
+      @resources ||= {}
+    end
+
+    def method_missing(name, *args, &block)
+      if self.class.resources.keys.include?(name)
+        resources[name] ||= self.class.resources[name].new(connection: connection)
+        resources[name]
+      else
+        super
+      end
+    end
+
+    def default_user_agent
+      "kinescope-rb/#{Kinescope::VERSION}"
+    end
+
+    private
+
+    def connection_options
+      {
+        url: api_url,
+        headers: {
+          authorization: "Bearer #{access_token}",
+          content_type: 'application/json',
+          user_agent: "#{user_agent} #{default_user_agent}".strip
+        }
+      }
+    end
+  end
+end

data/lib/kinescope/mappings/meta_mapping.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Kinescope
+  class OrderMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Order
+      root_key plural: 'order', singular: 'order', scopes: [:read]
+
+      property :created_at, scopes: [:read]
+      property :title, scopes: [:read]
+    end
+  end
+
+  class PaginationMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Pagination
+      root_key plural: 'pagination', singular: 'pagination', scopes: [:read]
+
+      property :page, scopes: [:read]
+      property :per_page, scopes: [:read]
+      property :total, scopes: [:read]
+    end
+  end
+
+  class MetaMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Meta
+      root_key plural: 'meta', singular: 'meta', scopes: [:read]
+
+      property :order, include: OrderMapping, scopes: [:read]
+      property :pagination, include: PaginationMapping, scopes: [:read]
+    end
+  end
+end

data/lib/kinescope/mappings/video_mapping.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Kinescope
+  class VideoMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Video
+      root_key plural: 'data', singular: 'data', scopes: [:read]
+
+      property :id, scopes: [:read]
+      property :project_id, scopes: [:read]
+      property :folder_id, scopes: [:read]
+      property :version, scopes: [:read]
+      property :title, scopes: [:read]
+      property :description, scopes: [:read]
+      property :status, scopes: [:read]
+      property :progress, scopes: [:read]
+      property :duration, scopes: [:read]
+      property :assets, scopes: [:read]
+      property :chapters, scopes: [:read]
+      property :privacy_type, scopes: [:read]
+      property :privacy_domains, scopes: [:read]
+      property :poster, scopes: [:read]
+      property :additional_materials, scopes: [:read]
+      property :additional_materials_enabled, scopes: [:read]
+      property :created_at, scopes: [:read]
+      property :updated_at, scopes: [:read]
+      property :play_link, scopes: [:read]
+      property :embed_link, scopes: [:read]
+      property :subtitles, scopes: [:read]
+      property :subtitles_enabled, scopes: [:read]
+      property :hls_link, scopes: [:read]
+    end
+  end
+end

data/lib/kinescope/models/base_model.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'virtus'
+
+module Kinescope
+  class BaseModel
+    include Virtus.model
+    include Virtus::Equalizer.new(name || inspect)
+
+    def inspect
+      variables = instance_variables.map { |name| [name, instance_variable_get(name)] }
+      values = Hash[variables]
+      "<#{self.class.name} #{values}>"
+    end
+  end
+end

data/lib/kinescope/models/meta.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kinescope
+  class Meta < BaseModel
+    attribute :order
+    attribute :pagination
+  end
+
+  class Order < BaseModel
+    attribute :created_at
+    attribute :title
+  end
+
+  class Pagination < BaseModel
+    attribute :page
+    attribute :per_page
+    attribute :total
+  end
+end

data/lib/kinescope/models/video.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kinescope
+  class Video < BaseModel
+    attribute :id
+    attribute :project_id
+    attribute :folder_id
+    attribute :version
+    attribute :title
+    attribute :description
+    attribute :status
+    attribute :progress
+    attribute :duration
+    attribute :assets
+    attribute :chapters
+    attribute :privacy_type
+    attribute :privacy_domains
+    attribute :poster
+    attribute :additional_materials
+    attribute :additional_materials_enabled
+    attribute :created_at
+    attribute :updated_at
+    attribute :play_link
+    attribute :embed_link
+    attribute :subtitles
+    attribute :subtitles_enabled
+    attribute :hls_link
+
+    def inspect
+      variables = [:@id, :@project_id, :@folder_id, :@title].map { |name| [name, instance_variable_get(name)] }
+      values = Hash[variables]
+      "<#{self.class.name} #{values}>"
+    end
+  end
+end

data/lib/kinescope/pagination_resource.rb

@@ -0,0 +1,44 @@
+module Kinescope
+  class PaginationResource
+    include Enumerable
+
+    attr_reader :action, :args, :resource
+    attr_accessor :page, :per_page, :total
+
+    def initialize(action, resource, *args)
+      @action = action
+      @resource = resource
+      @args = args
+
+      @collection = []
+      @page = nil
+      @per_page = nil
+      @total = nil
+    end
+
+    def [](index)
+      @collection[index]
+    end
+
+    def each(&block)
+      handle_response if total.nil?
+      return to_enum(:each) unless block_given?
+
+      @collection.each { |element| yield(element) }
+
+      self
+    end
+
+    private
+
+    def handle_response
+      invoker = ResourceKit::ActionInvoker.new(action, resource, *args)
+      @collection = invoker.handle_response
+
+      meta = Kinescope::MetaMapping.extract_single(invoker.response.body, :read)
+      self.page = meta.pagination.page
+      self.per_page = meta.pagination.per_page
+      self.total = meta.pagination.total
+    end
+  end
+end

data/lib/kinescope/resources/video_resource.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kinescope
+  class VideoResource < ResourceKit::Resource
+    # include ErrorHandler
+
+    resources do
+      action :all, 'GET /v1/videos' do
+        query_keys :page, :per_page, :project_id, :folder_id
+        handler(200) { |response| VideoMapping.extract_collection(response.body, :read) }
+      end
+    end
+
+    def all(*args)
+      PaginationResource.new(action(:all), self, *args)
+    end
+  end
+end

data/lib/kinescope/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Kinescope
+  VERSION = '0.1.0'.freeze
+end

data/lib/kinescope.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'kinescope/version'
+require 'resource_kit'
+require 'kartograph'
+
+module Kinescope
+  autoload :Client, 'kinescope/client'
+
+  # Models
+  autoload :BaseModel, 'kinescope/models/base_model'
+  autoload :Video, 'kinescope/models/video'
+  
+  # Mappings
+  autoload :VideoMapping, 'kinescope/mappings/video_mapping'
+
+  # Resources
+  autoload :VideoResource, 'kinescope/resources/video_resource'
+
+  # Meta
+  autoload :Meta, 'kinescope/models/meta'
+  autoload :Order, 'kinescope/models/meta'
+  autoload :Pagination, 'kinescope/models/meta'
+  autoload :MetaMapping, 'kinescope/mappings/meta_mapping'
+  autoload :PaginationResource, 'kinescope/pagination_resource'
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: kinescope-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- droff
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: kartograph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: resource_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+description: ''
+email:
+- adroff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kinescope-rb.gemspec
+- lib/kinescope.rb
+- lib/kinescope/client.rb
+- lib/kinescope/mappings/meta_mapping.rb
+- lib/kinescope/mappings/video_mapping.rb
+- lib/kinescope/models/base_model.rb
+- lib/kinescope/models/meta.rb
+- lib/kinescope/models/video.rb
+- lib/kinescope/pagination_resource.rb
+- lib/kinescope/resources/video_resource.rb
+- lib/kinescope/version.rb
+homepage: https://github.com/droff/kinescope-rb
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []