frameio-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0901a5840882914621de78e0c9e36bbff287aca801994e5b88201b96ecf31683'
+  data.tar.gz: 5223091ad97b2e6b46220e98d3b476e4b71351840b6b29de00dd5795306f474b
+SHA512:
+  metadata.gz: 6f4eca7dc8eb1cd7c2b8ddab1093412e37d7c8fbcee759513b00feac7367e45c957d215d4116e921438bf98ce30193b25b9db0b3fa2dda848ff6d5278249c836
+  data.tar.gz: 631a196ecd6d488ebf56f085b414783c07fda7bc4b6c44751897b2f85903e0a06d34868b90f225ae1ec56df574ee2468e8b08a01f85e17d786f454ba612852bb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Victor Holl
+
+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,101 @@
+# FrameIo
+Very basic (and wip) Frame.io API wrapper
+Only OAuth2 authentification available at the moment.
+
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "frame_io"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install frame_io
+```
+
+
+## Usage
+This gem uses and bundles [omniauth-frameio](https://github.com/boxprod/omniauth-frameio)
+
+### Omniauth configuration:
+
+This Strategy is meant to be used with [Omniauth](https://github.com/omniauth/omniauth) and has been tested and used with [Devise](https://github.com/heartcombo/devise#omniauth)
+
+If using Devise, add this in your Devise.setup in /config/initializers/devise.rb
+
+```ruby
+config.omniauth   :frameio,
+                  ENV['FRAME_CLIENT_ID'], # Your app client ID (on Frame.io Oauth app mgmt)
+                  ENV['FRAME_CLIENT_SECRET'], # Your app client Secret (on Frame.io Oauth app mgmt)
+                  scope: 'offline' # list of availables scopes to find on Frame.io dev doc
+```
+
+Please follow Omniauth & Devise instructions for complete configuration.
+
+### Wrapper configuration:
+
+```ruby
+class User < ApplicationRecord
+  act_as_frameio_user
+end
+```
+
+By default, frame_io wrapper is expecting the model to respond_to? :access_token, :refresh_token and :expires_at
+
+If you want to change the column names:
+
+```ruby
+class User < ApplicationRecord
+  act_as_frameio_user access_token: :some_column, refresh_token: :some_other_column, expires_at: :oh_so_other_column
+end
+```
+
+That's all! You now have access to a frame.io client:
+
+```ruby
+current_user.frame_io #=> FrameIo::Client
+
+current_user.frame_io.accounts #=> All accounts for user frame.io account
+```
+
+Due to the nature of the 'tree' on Frame.io, objects needs to be retrieved in chain
+
+```ruby
+current_user.accounts.first.teams.first.projects.first.assets.first.children
+```
+
+Each step is cached by default. If you need to refresh, you can pass:
+```ruby
+cache: false
+```
+at any moment, like that:
+
+```ruby
+current_user.frame_io.accounts.first.teams.first.projects(cache: false).first.assets
+```
+
+It will refresh from projects and downward.
+
+
+Lastly, all objects are findable by ID without the need of the 'chain', like that:
+
+```ruby
+current_user.frame_io.asset(id: 'some_id')
+```
+
+It obviously works if and only current_user has access to the file in Frame.io
+
+
+## Contributing
+Please raise issues at will, and suggest better ways to handle this!
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/frame_io/account.rb

@@ -0,0 +1,17 @@
+module FrameIo
+  class Account < OpenStruct
+    def self.all(client:)
+      client.get_resource('accounts', object_class: self)
+    end
+
+    def self.find(id:, client:)
+      client.get_resource("accounts/#{id}", object_class: self)
+    end
+
+    def teams(cache: true)
+      @teams = nil unless cache
+
+      @teams ||= Team.all(account: self, client:)
+    end
+  end
+end

data/lib/frame_io/active_record_extension.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Base.extend(Module.new do
+  def act_as_frameio_user(opts = {})
+    FrameIo.access_token = opts[:access_token]
+    FrameIo.refresh_token = opts[:refresh_token]
+    FrameIo.expires_at = opts[:expires_at]
+    include FrameIo
+  end
+end)

data/lib/frame_io/asset.rb

@@ -0,0 +1,23 @@
+module FrameIo
+  class Asset < OpenStruct
+    def self.children(asset:, client:)
+      client.get_resource("assets/#{asset.id}/children", object_class: self)
+    end
+
+    def self.find(id:, client:)
+      client.get_resource("assets/#{id}", object_class: self)
+    end
+
+    def account(cache: true)
+      @account = nil unless cache
+
+      @account ||= Account.find(id: account_id, client:)
+    end
+
+    def children(cache: true)
+      @children = nil unless cache
+
+      @children ||= Asset.children(asset: self, client:)
+    end
+  end
+end

data/lib/frame_io/client.rb

@@ -0,0 +1,90 @@
+module FrameIo
+  class Client
+    attr_reader :user, :api_key
+
+    def initialize(user:)
+      @user = user
+    end
+
+    def get_resource(resource_path, object_class:)
+      check_token
+      response = token.get(resource_path)
+      result = JSON.parse(
+        response.body,
+        symbolize_names: true,
+        object_class:
+      )
+      if result.is_a? OpenStruct
+        result.client = self
+      elsif result.is_a? Array
+        result.each { _1.client = self }
+      end
+      result
+    end
+
+    def token
+      OAuth2::AccessToken.from_hash(
+        oauth.client,
+        {
+          access_token: user.send(FrameIo.access_token),
+          refresh_token: user.send(FrameIo.refresh_token),
+          expires_at: user.send(FrameIo.expires_at)
+        }
+      )
+    end
+
+    def oauth
+      OmniAuth::Strategies::Frameio.new(
+        nil,
+        ENV['FRAME_CLIENT_ID'],
+        ENV['FRAME_CLIENT_SECRET']
+      )
+    end
+
+    def accounts(cache: true)
+      @accounts = nil unless cache
+
+      @accounts ||= Account.all(client: self)
+    end
+
+    def current_user
+      User.current(client: self)
+    end
+
+    def account(id:)
+      Account.find(id:, client: self)
+    end
+
+    def team(id:)
+      Team.find(id:, client: self)
+    end
+
+    def project(id:)
+      Project.find(id:, client: self)
+    end
+
+    def asset(id:)
+      Asset.find(id:, client: self)
+    end
+
+    def custom_action(id:)
+      CustomAction.find(id:, client: self)
+    end
+
+    private
+
+    def check_token
+      return unless token.expired?
+
+      new_token = token.refresh!
+
+      raise TokenError, 'something went wrong with token refresh' unless new_token.present?
+
+      user.update(
+        frameio_token: new_token.token,
+        frameio_token_expires_at: Time.at(new_token.expires_at),
+        frameio_refresh_token: new_token.refresh_token
+      )
+    end
+  end
+end

data/lib/frame_io/collaborator.rb

@@ -0,0 +1,7 @@
+module FrameIo
+  class Collaborator < OpenStruct
+    def self.all(project:, client:)
+      client.get_resource("projects/#{project.id}/collaborators", object_class: self)
+    end
+  end
+end

data/lib/frame_io/custom_action.rb

@@ -0,0 +1,11 @@
+module FrameIo
+  class CustomAction < OpenStruct
+    def self.all(team:, client:)
+      client.get_resource("teams/#{team.id}/actions", object_class: self)
+    end
+
+    def self.find(id:, client:)
+      client.get_resource("actions/#{id}", object_class: self)
+    end
+  end
+end

data/lib/frame_io/project.rb

@@ -0,0 +1,31 @@
+module FrameIo
+  class Project < OpenStruct
+    def self.all(team:, client:)
+      client.get_resource("teams/#{team.id}/projects", object_class: self)
+    end
+
+    def self.find(id:, client:)
+      client.get_resource("projects/#{id}", object_class: self)
+    end
+
+    def root
+      @root ||= Asset.find(id: root_asset.id, client:)
+    end
+
+    def account
+      root.account
+    end
+
+    def assets(cache: true)
+      @assets = nil unless cache
+
+      @assets ||= root.children(cache:)
+    end
+
+    def collaborators(cache: true)
+      @collaborators = nil unless cache
+
+      @collaborators ||= Collaborator.all(project: self, client:)
+    end
+  end
+end

data/lib/frame_io/railtie.rb

@@ -0,0 +1,4 @@
+module FrameIo
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/frame_io/team.rb

@@ -0,0 +1,23 @@
+module FrameIo
+  class Team < OpenStruct
+    def self.all(account:, client:)
+      client.get_resource("accounts/#{account.id}/teams?include=user_role", object_class: self)
+    end
+
+    def self.find(id:, client:)
+      client.get_resource("teams/#{id}", object_class: self)
+    end
+
+    def projects(cache: true)
+      @projects = nil unless cache
+
+      @projects ||= Project.all(team: self, client:)
+    end
+
+    def custom_actions(cache: true)
+      @custom_actions = nil unless cache
+
+      @custom_actions ||= CustomAction.all(team: self, client:)
+    end
+  end
+end

data/lib/frame_io/user.rb

@@ -0,0 +1,7 @@
+module FrameIo
+  class User < OpenStruct
+    def self.current(client:)
+      client.get_resource('me', object_class: self)
+    end
+  end
+end

data/lib/frame_io/version.rb

@@ -0,0 +1,3 @@
+module FrameIo
+  VERSION = "0.1.0"
+end

data/lib/frame_io.rb

@@ -0,0 +1,47 @@
+require "frame_io/version"
+require "frame_io/railtie"
+require 'frame_io/account'
+require 'frame_io/active_record_extension'
+require 'frame_io/asset'
+require 'frame_io/client'
+require 'frame_io/collaborator'
+require 'frame_io/custom_action'
+require 'frame_io/project'
+require 'frame_io/team'
+require 'frame_io/user'
+require 'omniauth-frameio'
+
+module FrameIo
+  TokenError = Class.new(StandardError)
+
+  class << self
+    attr_writer :access_token, :refresh_token, :expires_at
+  end
+
+  def self.included(base)
+    return if [
+      access_token,
+      refresh_token,
+      expires_at
+    ].all? { base.attribute_method? _1 }
+
+    raise TokenError, "#{base} must implement ##{access_token}, ##{refresh_token}, ##{expires_at} or define otherwise at include."
+  end
+
+  def frame_io
+    Client.new(user: self)
+  end
+
+  def self.access_token
+    @access_token || :access_token
+  end
+
+  def self.refresh_token
+    @refresh_token || :refresh_token
+  end
+
+  def self.expires_at
+    @expires_at || :expires_at
+  end
+end
+

data/lib/tasks/frame_io_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :frame_io do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: frameio-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor Holl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-frameio
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+description: Basic and WIP API wrapper for Frame.io. Uses OAuth2 and omniauth-frameio
+  strategy gem.
+email:
+- v_h@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/frame_io.rb
+- lib/frame_io/account.rb
+- lib/frame_io/active_record_extension.rb
+- lib/frame_io/asset.rb
+- lib/frame_io/client.rb
+- lib/frame_io/collaborator.rb
+- lib/frame_io/custom_action.rb
+- lib/frame_io/project.rb
+- lib/frame_io/railtie.rb
+- lib/frame_io/team.rb
+- lib/frame_io/user.rb
+- lib/frame_io/version.rb
+- lib/tasks/frame_io_tasks.rake
+homepage: https://github.com/boxprod/frame_io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/boxprod/frame_io
+  source_code_uri: https://github.com/boxprod/frame_io
+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.5.3
+signing_key:
+specification_version: 4
+summary: Basic API Wrapper for Frame.io using OAuth2
+test_files: []