editframe 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a85cce0aa23b0b803d73b2a846ec714675da8a33821b4f44e6a9964b6fb97e5
+  data.tar.gz: bd35d0d4fce47c9f07fb240e80c3694367ddf7d825a0aa638904eb3c25ae9150
+SHA512:
+  metadata.gz: d973fefea0b70442d8ab838432ce2c15ecc46038f4d51b4977a0b71cc779c7de535341be2093069e64a77bc157f999cf025e9700cf6512a1d3b5902a9bec6f38
+  data.tar.gz: 71f0976ac0b3bd5f4f861d0593daab7b2b7c172eb2f074ad7fc26a70837a89b3ca23b8212db9d2d7f42cb07ba53f975c8cf8789744775aa991c6e24cdcefa8de

data/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in editframe.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Editframe, Inc.
+
+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,37 @@
+# Editframe
+
+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/editframe`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'editframe'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install editframe
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/editframe/editframe-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "editframe"
+
+# 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(__FILE__)

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/editframe.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/editframe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "editframe"
+  spec.version       = Editframe::VERSION
+  spec.authors       = ["Bryce"]
+  spec.email         = ["bryce@brycedev.com"]
+
+  spec.summary       = "Ruby bindings for the Editframe API"
+  spec.description   = "Official Rails library for interacting with the Editframe.com API"
+  spec.homepage      = "https://editframe.com/docs/sdk/ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/editframe/editframe-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/editframe/editframe-ruby/CHANGELOG.md"
+
+  spec.add_dependency "faraday", "~> 1.5"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/editframe.rb

@@ -0,0 +1,31 @@
+require "json"
+require "uri"
+
+require "editframe/api_resource"
+require "editframe/resources"
+require "editframe/util"
+require "editframe/version"
+
+require "editframe/video/builder"
+require "editframe/video/clip"
+
+module Editframe
+  @api_host = 'api.editframe.com'
+  @api_key = nil
+  @api_version = '2'
+  @client_id = nil 
+
+  class << self
+    attr_accessor :api_key, :client_id
+    attr_reader :api_host, :api_version
+    
+  end
+
+  def self.set_api_host(host)
+    @api_host = host
+  end 
+
+  def self.set_api_version(version)
+    @api_version = version.to_s
+  end 
+end

data/lib/editframe/api_resource.rb

@@ -0,0 +1,47 @@
+require 'faraday'
+require 'json'
+
+module Editframe
+  class APIResource
+    def self.base_url
+      "https://#{Editframe::api_host}/v#{Editframe::api_version}/#{self::OBJECT_PATH}"
+    end
+
+    def self.all
+      perform_get_request()['data']
+    end
+
+    def self.find(identifier)
+      perform_get_request("#{identifier}")['data']
+    end
+
+    def self.perform_get_request(url = '', params: {}, options: {})
+      response = Faraday.new(url: base_url, params: params, headers: retrieve_headers).get(url)
+      JSON.parse(response.body)
+    end
+
+    def self.perform_post_request(url = '', body: {}, options: {}, is_form: false)
+      headers = retrieve_headers
+      request = Faraday.new(url: base_url, headers: headers)
+      if is_form 
+        headers.delete('Accept')
+        headers.delete('Content-Type')
+        request = Faraday.new(url: base_url, headers: headers) do |f|
+          f.request :multipart
+        end
+      end
+      request = request.post(url, body)
+      JSON.parse(request.body)
+    end
+
+    def self.retrieve_headers
+      headers = { 
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{Editframe::api_key}",
+        'Editframe-Client-Id' => "#{Editframe.client_id}"
+      }
+      headers
+    end
+  end
+end 

data/lib/editframe/resources.rb

@@ -0,0 +1,2 @@
+require "editframe/resources/application"
+require "editframe/resources/video"

data/lib/editframe/resources/application.rb

@@ -0,0 +1,7 @@
+module Editframe 
+  class Application < APIResource 
+
+    OBJECT_PATH = 'applications/'
+    
+  end
+end

data/lib/editframe/resources/video.rb

@@ -0,0 +1,23 @@
+module Editframe 
+  class Video < APIResource 
+
+    OBJECT_PATH = 'videos/'
+
+    def self.build(options)
+      VideoBuilder.new options
+    end 
+
+    def self.encode(body)
+      self.perform_post_request(body: body, is_form: true)
+    end
+
+    def self.encode_from_clip(body)
+      self.perform_post_request('clip', body: body, is_form: true)
+    end
+
+    def self.from_clip(options)
+      VideoClip.new options
+    end 
+    
+  end
+end

data/lib/editframe/util.rb

@@ -0,0 +1,30 @@
+require 'securerandom'
+
+module Editframe
+  class Util 
+    def self.dimensions_for_aspect_ratio(aspect_ratio, hd = false)
+      case aspect_ratio
+      when '1:1'
+        hd ? { :width => 1024, :height => 1024 } :  { :width => 700, :height => 700 }
+      when '16:9'
+        hd ? { :width => 1920, :height => 1080 } :  { :width => 1024, :height => 576 }
+      when '5:4'
+        hd ? { :width => 1280, :height => 1024 } :  { :width => 640, :height => 512 }
+      when '4:5'
+        hd ? { :width => 1024, :height => 1280 } :  { :width => 512, :height => 640 }
+      when '9:16'
+        hd ? { :width => 1080, :height => 1920 } :  { :width => 576, :height => 1024 }
+      end
+    end
+
+    def self.dimensions_for_resolution(resolution = '700x700')
+      return {} unless !resolution.nil?
+      values = resolution.split('x')
+      { width: values[0].to_i, height: values[1].to_i }
+    end
+
+    def self.uuid
+      SecureRandom.uuid.slice(0,6)
+    end 
+  end 
+end

data/lib/editframe/version.rb

@@ -0,0 +1,3 @@
+module Editframe
+  VERSION = "0.1.1"
+end

data/lib/editframe/video/builder.rb

@@ -0,0 +1,74 @@
+module Editframe
+  class VideoBuilder
+
+    attr_reader :layers
+
+    def initialize(options = {})
+      @form = {}
+      @layers = []
+      @options = options || { background_color: 'black', resolution: '700x700', duration: 10 }
+    end
+
+    def add_audio(source, options = {})
+      layer = add_layer({ :type => 'audio', **options })
+      add_asset(layer[:id], source)
+      layer
+    end
+
+    def add_image(source, options = {})
+      layer = add_layer({ :type => 'image', **options })
+      add_asset(layer[:id], source)
+      layer
+    end
+
+    def add_text(text, options = {})
+      layer = add_layer({ :type => 'waveform', :text => text, **options })
+      layer
+    end
+
+    def add_video(source, options = {})
+      layer = add_layer({ :type => 'video', **options })
+      add_asset(layer[:id], source)
+      layer
+    end
+
+    def add_waveform(options = {})
+      layer = add_layer({ :type => 'waveform', **options })
+      layer
+    end
+                                                            
+    def encode
+      @form[:config] = Faraday::ParamPart.new(generate_config, 'application/json')
+      Editframe::Video.encode(@form)
+    end
+
+    private def add_asset(id, source)
+      case source
+      when String
+        @form["url#{id}"] = source
+      when File
+        @form["file#{id}"] = Faraday::FilePart.new source, 'application/octet-stream'
+      end
+    end 
+
+    private def add_layer(options = {})
+      layer = { id: Util::uuid, **options }
+      @layers.push layer 
+      layer
+    end 
+
+    private def generate_config 
+      options = @options
+      dimensions = Util::dimensions_for_resolution options[:resolution]
+      if options.key? :aspect_ratio
+        hd = options.key? :hd ? options[:hd] : false
+        dimensions = Util::dimensions_for_aspect_ratio(options[:aspect_ratio], hd)
+      end
+      options[:hd] = dimensions[:width] >= 1024
+      options.delete(:resolution)
+      options.stringify_keys!
+      options.deep_transform_keys! { |key| key.camelize :lower }
+      { **options, :dimensions => dimensions, :layers => @layers }.to_json
+    end 
+  end 
+end

data/lib/editframe/video/clip.rb

@@ -0,0 +1,89 @@
+module Editframe
+  class VideoClip
+
+    attr_reader :layers
+
+    def initialize(source, options = {})
+      @id = Util.uuid
+      @form = {}
+      @filters = []
+      @layers = []
+      @options = options || { }
+      @resolution = { width: nil, height: nil }
+      @trim = { start: 0, end: nil }
+      @volume = 1.0
+      configure_source source
+    end
+
+    def filter(name, options = {})
+      @filters.push({ :name => name, :options => { **options } })
+      self
+    end
+
+    def resize(resolution)
+      return unless !resolution.nil?
+      set_resolution resolution
+      self
+    end
+
+    def set_resolution(resolution)
+      return unless !resolution.nil?
+      values = resolution.split('x')
+      @resolution = { width: values[0].to_i, height: values[1].to_i }
+      self
+    end
+
+    def set_volume(volume)
+      @volume = volume.to_f
+      if volume > 1 then @volume = 1.0 end
+      if volume < 1 then @volume = 0.0 end
+      self
+    end
+
+    def trim(trim_start, trim_end)
+      @trim[:start] = trim_start
+      @trim[:end] = trim_end
+      if @trim[:start] < 0 
+        @trim[:start] = 0
+      end
+      if @trim[:end] < 0 
+        @trim.delete(:end)
+      end
+      self
+    end
+
+    def mute 
+      set_volume 0 
+      self
+    end
+                                            
+    def encode
+      @form[:config] = Faraday::ParamPart.new(generate_config, 'application/json')
+      Editframe::Video.encode_from_clip(@form)
+    end
+
+    private def configure_source(source)
+      case source
+      when String
+        @form["url#{@id}"] = source
+      when File
+        @form["file#{@id}"] = Faraday::FilePart.new source, 'application/octet-stream'
+      end
+      @source = source
+    end 
+
+    private def generate_config 
+      clip = { :id => @id, :filters => @filters, :volume => @volume }
+      options = @options
+      if !@trim[:end].nil?
+        clip[:trim] = @trim
+      end
+      if (!@resolution[:width].nil?) and (!@resolution[:height].nil?)
+        clip[:resolution] = @resolution
+      end
+      options.stringify_keys!
+      options.deep_transform_keys! { |key| key.camelize :lower }
+      { **options, :layers => @layers, :clip => clip }.to_json
+    end 
+  end 
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: editframe
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Bryce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Official Rails library for interacting with the Editframe.com API
+email:
+- bryce@brycedev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- editframe.gemspec
+- lib/editframe.rb
+- lib/editframe/api_resource.rb
+- lib/editframe/resources.rb
+- lib/editframe/resources/application.rb
+- lib/editframe/resources/video.rb
+- lib/editframe/util.rb
+- lib/editframe/version.rb
+- lib/editframe/video/builder.rb
+- lib/editframe/video/clip.rb
+homepage: https://editframe.com/docs/sdk/ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://editframe.com/docs/sdk/ruby
+  source_code_uri: https://github.com/editframe/editframe-ruby
+  changelog_uri: https://github.com/editframe/editframe-ruby/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.24
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Editframe API
+test_files: []