strawberry_api 0.1.0

data/lib/strawberry_api/http_client.rb

@@ -0,0 +1,135 @@
+require 'httparty'
+
+module StrawberryAPI
+  # Class HttpClient provides a way to query a remote HTTP server
+  # It shamelessly uses the HTTParty gem for all the dirty job
+  #
+  # @author Pierre Lebrun <pierreyves.lebrun@gmail.com>
+  #
+  class HttpClient
+
+    include HTTParty
+    headers 'Accept': 'application/json', 'Content-Type': 'application/json', 'X-FLAVOURSYS-CLIENT': 'API client 1.0'
+    
+    # Class HTTParty::Response provides methods to handle HTTP reponses
+    #
+    # @author John Nunemaker <nunemaker@gmail.com>
+    #
+    class HTTParty::Response
+      # Alias for HTTParty parsed_reponse method
+      alias_method :parse, :parsed_response
+    end
+
+    # Logs in and stores authentication session
+    #
+    # @option [String] host Hostname or IP address of Strawberry server
+    # @option [String] username Username of Strawberry's user
+    # @option [String] password Password of Strawberry's user
+    # @option [String] api_key API key of Strawberry's user
+    #
+    # @return [StrawberryAPI::API:User] logged in user
+    #
+    def initialize(**options)
+      if options.empty?
+        username = StrawberryAPI.config.username
+        password = StrawberryAPI.config.password
+        api_key = StrawberryAPI.config.api_key
+      else
+        username = options[:username]
+        password = options[:password]
+        api_key = options[:api_key]
+      end
+
+      self.class.base_uri("http://#{StrawberryAPI.config.host}/api/v1")
+
+      if api_key
+        self.class.get("/session", headers: {Authorization: "Bearer #{api_key}"}).success?
+        
+        @headers = self.class.headers.dup
+        @headers[:Authorization] = "Bearer #{api_key}"
+      elsif username && password
+        session = self.class.post('/session', query: {login: username, password: password})
+        authentication_token = session.parse['authentication_token']
+
+        @cookies = self.class.cookies.dup
+        @cookies[:_auth_token] = authentication_token
+      else
+        raise 'Invalid credentials provided'
+      end
+    end
+
+    def request(method, path, mute_failure: false, **options)
+      options[:headers] = @headers
+      options[:cookies] = @cookies
+      
+      response = self.class.send(method, path, options)
+      
+      if mute_failure
+        response
+      else
+        handle_response(response)
+      end
+    end
+
+    # Handles HTTParty reponse
+    #
+    # @param [HTTParty::Response] response
+    #
+    # @return [HTTParty::Response] HTTP reponse
+    #
+    # @raise [String] Indicates the reponse error code and information
+    # 
+    def handle_response(response)
+      if response.success?
+        response
+      else
+        raise "#{response.code} #{response['error']}"
+      end
+    end
+    
+    # Overrides HTTPary reponse handling
+    #
+    # @param [String] path
+    # @param [String] mute_failure Prevents error raise if request fails
+    #
+    # @return [HTTParty::Response] API response
+    # 
+    def get(path, mute_failure: false, **options)
+      request(:get, path, mute_failure: false, **options)
+    end
+
+    # Overrides HTTPary reponse handling
+    #
+    # @param [String] path
+    # @param [String] mute_failure Prevents error raise if request fails
+    #
+    # @return [HTTParty::Response] API response
+    # 
+    def post(path, mute_failure: false, **options)
+      request(:post, path, mute_failure: false, **options)
+    end
+
+    # Overrides HTTPary reponse handling
+    #
+    # @param [String] path
+    # @param [String] mute_failure Prevents error raise if request fails
+    #
+    # @return [HTTParty::Response] API response
+    # 
+    def put(path, mute_failure: false, **options)
+      request(:put, path, mute_failure: false, **options)
+    end
+
+    # Overrides HTTPary reponse handling
+    #
+    # @param [String] path
+    # @param [String] mute_failure Prevents error raise if request fails
+    #
+    # @return [HTTParty::Response] API response
+    # 
+    def delete(path, mute_failure: false, **options)
+      request(:delete, path, mute_failure: false, **options)
+    end
+
+  end
+end

data/lib/strawberry_api/library.rb

@@ -0,0 +1,19 @@
+module StrawberryAPI
+  
+  class Library
+
+    attr_accessor :id
+    attr_accessor :project_id
+    attr_accessor :ingest_path
+    attr_accessor :ingest_storage
+    attr_accessor :options
+    attr_accessor :ingest_path_exists
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k.gsub(/[!@#$%^&*?']/, '')}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/strawberry_api/marker.rb

@@ -0,0 +1,22 @@
+module StrawberryAPI
+  
+  class Marker
+
+    attr_accessor :id
+    attr_accessor :asset_id
+    attr_accessor :text
+    attr_accessor :created_by
+    attr_accessor :in
+    attr_accessor :out
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :guid
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k.gsub(/[!@#$%^&*?']/, '')}", v) unless v.nil?
+      end
+    end
+    
+  end
+end

data/lib/strawberry_api/project.rb

@@ -0,0 +1,48 @@
+module StrawberryAPI
+  
+  class Project
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :size
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :locked_by
+    attr_accessor :templatename
+    attr_accessor :template_type
+    attr_accessor :last_opened_by
+    attr_accessor :created_by
+    attr_accessor :last_used_at
+    attr_accessor :delta
+    attr_accessor :user_id
+    attr_accessor :archive_strategy_id
+    attr_accessor :archive_strategy_state
+    attr_accessor :frozen_by_id
+    attr_accessor :is_library_project
+    attr_accessor :last_opened_by_edit
+    attr_accessor :created_by_edit
+    attr_accessor :deleted
+    attr_accessor :owner_id
+    attr_accessor :quota
+    attr_accessor :prefix
+    attr_accessor :encoding_priority
+    attr_accessor :fsp_cache
+    attr_accessor :alternative_name
+    attr_accessor :tiering_storage
+    attr_accessor :tiered_at
+    attr_accessor :mounted_by
+    attr_accessor :subprojects
+    attr_accessor :parentprojects
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        if k == 'archive_strategy_state'
+          ArchiveStrategyState.new(v)
+        end
+        
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/strawberry_api/proxy.rb

@@ -0,0 +1,28 @@
+module StrawberryAPI
+  
+  class Proxy
+
+    attr_accessor :id
+    attr_accessor :asset_id
+    attr_accessor :path
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :in_progress
+    attr_accessor :preview_ext
+    attr_accessor :thumbnail_ext
+    attr_accessor :animation_ext
+    attr_accessor :structure_version
+    attr_accessor :video
+    attr_accessor :thumbnail
+    attr_accessor :animation
+    attr_accessor :preview
+    attr_accessor :stream
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+  end
+end

data/lib/strawberry_api/role.rb

@@ -0,0 +1,18 @@
+module StrawberryAPI
+  
+  class Role
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :size
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/strawberry_api/schedule.rb

@@ -0,0 +1,44 @@
+module StrawberryAPI
+  
+  class Schedule
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :size
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :locked_by
+    attr_accessor :templatename
+    attr_accessor :template_type
+    attr_accessor :last_opened_by
+    attr_accessor :created_by
+    attr_accessor :last_used_at
+    attr_accessor :delta
+    attr_accessor :user_id
+    attr_accessor :archive_strategy_id
+    attr_accessor :archive_strategy_state_id
+    attr_accessor :frozen_by_id
+    attr_accessor :is_library_project
+    attr_accessor :last_opened_by_edit
+    attr_accessor :created_by_edit
+    attr_accessor :deleted
+    attr_accessor :owner_id
+    attr_accessor :quota
+    attr_accessor :prefix
+    attr_accessor :encoding_priority
+    attr_accessor :fsp_cache
+    attr_accessor :alternative_name
+    attr_accessor :tiering_storage
+    attr_accessor :tiered_at
+    attr_accessor :mounted_by
+    attr_accessor :subprojects
+    attr_accessor :parentprojects
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+  end
+end

data/lib/strawberry_api/session.rb

@@ -0,0 +1,7 @@
+module StrawberryAPI
+  
+  class Session
+    
+  end
+
+end

data/lib/strawberry_api/setting.rb

@@ -0,0 +1,12 @@
+module StrawberryAPI
+  
+  class Setting
+  
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/strawberry_api/status_flag.rb

@@ -0,0 +1,12 @@
+module StrawberryAPI
+  
+  class StatusFlag
+
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+  end
+end

data/lib/strawberry_api/strategy/archive_strategy.rb

@@ -0,0 +1,10 @@
+module StrawberryAPI
+  
+  class ArchiveStrategy < StrawberryAPI::Strategy
+
+    attr_accessor :includes
+    attr_accessor :transmission_check
+    attr_accessor :strategy_type
+
+  end
+end

data/lib/strawberry_api/strategy/archive_strategy_state.rb

@@ -0,0 +1,25 @@
+module StrawberryAPI
+  
+  class ArchiveStrategyState
+
+    attr_accessor :id
+    attr_accessor :archive_strategy_id
+    attr_accessor :user_id
+    attr_accessor :project_id
+    attr_accessor :direction
+    attr_accessor :state
+    attr_accessor :error
+    attr_accessor :stage
+    attr_accessor :progress
+    attr_accessor :started_at
+    attr_accessor :cancelled
+    attr_accessor :exclude_linked_files
+
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/strawberry_api/strategy/asset_copy_to_strategy.rb

@@ -0,0 +1,6 @@
+module StrawberryAPI
+  
+  class AssetCopyToStrategy < StrawberryAPI::Strategy
+    
+  end
+end

data/lib/strawberry_api/strategy/project_copy_to_strategy.rb

@@ -0,0 +1,9 @@
+module StrawberryAPI
+  
+  class ProjectCopyToStrategy < StrawberryAPI::Strategy
+
+    attr_accessor :includes
+    attr_accessor :contents
+    attr_accessor :delete_project
+  end
+end

data/lib/strawberry_api/strategy.rb

@@ -0,0 +1,19 @@
+module StrawberryAPI
+  
+  class Strategy
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :destination
+    attr_accessor :format
+    attr_accessor :admin_only
+    attr_accessor :enabled
+
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+  end
+  
+end

data/lib/strawberry_api/team.rb

@@ -0,0 +1,27 @@
+module StrawberryAPI
+  
+  class Team
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :quota_mail_sent
+    attr_accessor :quota
+    attr_accessor :space_used
+    attr_accessor :users
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        if k == 'users'
+          v.map! do |user|
+            User.new(user)
+          end
+        end
+        
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+  end
+end

data/lib/strawberry_api/template.rb

@@ -0,0 +1,20 @@
+module StrawberryAPI
+  
+  class Template
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :template_type
+    attr_accessor :position
+    attr_accessor :substitution_patterns
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/strawberry_api/user.rb

@@ -0,0 +1,30 @@
+module StrawberryAPI
+  
+  class User
+
+    attr_accessor :id
+    attr_accessor :username
+    attr_accessor :authentication_token
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :firstname
+    attr_accessor :lastname
+    attr_accessor :own_team_id
+    attr_accessor :role_id
+    attr_accessor :role
+    attr_accessor :teams
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        if k == 'teams'
+          v.map! do |team|
+            Team.new(team)
+          end
+        end
+        
+        instance_variable_set("@#{k.gsub(/[!@#$%^&*?']/, '')}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/strawberry_api/version.rb

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

data/lib/strawberry_api.rb

@@ -0,0 +1,36 @@
+require 'strawberry_api/configuration'
+require 'strawberry_api/http_client'
+require 'strawberry_api/client'
+require 'strawberry_api/version'
+
+# module StrawberryAPI provides access to Strawberry REST API
+#
+# @author Pierre Lebrun <pierreyves.lebrun@gmail.com>
+#
+module StrawberryAPI
+
+  # Return configuration
+  # If it has not been configured yet, initialize configuration
+  # @return [StrawberryAPI::Configuration] configuration object
+  def self.config
+    @config ||= StrawberryAPI::Configuration.new
+  end
+
+  # Set configuration
+  #
+  # @param config [StrawberryAPI::Configuration] configuration object
+  # @return [StrawberryAPI::Configuration] configuration object
+  def self.config=(config)
+    raise TypeError unless config.is_a?(StrawberryAPI::Configuration)
+    @config = config
+  end
+
+  # Configure some settings
+  #
+  # @yield [config] Given configuration object
+  # @yieldparam config [StrawberryAPI::Configuration] configuration object
+  #
+  def self.configure
+    yield(config)
+  end
+end

data/samples/README.md

@@ -0,0 +1,14 @@
+## Samples
+
+* [Login](login.rb)
+    * Client authenticating via both credentials and authentication tokens
+    * Uses the `logged_in?` method to confirm authentication successed
+
+* [Projects listing](list_projects.rb)
+    * Client authenticating via credentials
+    * Uses `projects` method to fetch all projects
+
+* [Assets links listing](list_assets_links.rb)
+    * Client authenticating via credentials
+    * Uses `methods` method to fetch all projects
+    * Uses `links` method on each asset to fetch the its links to other projects

data/samples/list_assets_links.rb

@@ -0,0 +1,15 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'strawberry_api')
+
+# Logs in to Strawberry server
+strawberry = StrawberryAPI::Client.new(host: 'server_IP_or_hostname', username: 'username', password: 'password')
+
+# Gets all Strawberry assets
+StrawberryAPI.assets.each do |asset|
+  # Makes sure the asset is a video
+  # We don't care about other media types, they are muggles
+  if asset.video?
+    puts "The asset #{asset.name} is linked to the following projects:"
+    p asset.links
+  end
+end

data/samples/list_projects.rb

@@ -0,0 +1,14 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'strawberry_api')
+
+# Configures API client
+StrawberryAPI.configure do |c|
+  c.host = 'server_IP_or_hostname'
+  c.api_key = 'api_key'
+end
+
+# Instanciates a new client using the above config
+strawberry = StrawberryAPI::Client.new
+
+# Lists all projects
+p StrawberryAPI.projects

data/samples/login.rb

@@ -0,0 +1,18 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'strawberry_api')
+
+# Configures API client
+StrawberryAPI.configure do |c|
+  c.host = 'server_IP_or_hostname'
+  c.api_key = 'api_key'
+end
+
+# Instanciates a new client using the above config
+strawberry = StrawberryAPI::Client.new
+
+# Shows whether login was successful or not
+if StrawberryAPI.logged_in?
+  p 'Successfully logged in!'
+else
+  p 'Failed logging in...'
+end

data/samples/test.rb

@@ -0,0 +1,12 @@
+require 'pp'
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'strawberry_api')
+
+StrawberryAPI.configure do |c|
+  c.host = '10.240.51.151'
+  c.api_key = '7a8d4f46550e875a57a955c3897f75a4'
+end
+
+sb1 = StrawberryAPI::Client.new
+p sb1.library(project_id: 24)
+

data/strawberry_api.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "strawberry_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "strawberry_api"
+  spec.version       = StrawberryAPI::VERSION
+  spec.authors       = ["Pierre Lebrun"]
+  spec.email         = ["pierreyves.lebrun@gmail.com"]
+
+  spec.summary       = "Strawberry API client"
+  spec.description   = "This gem is a client for Flavousys Strawberry REST API"
+  #spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  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"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  
+  spec.add_runtime_dependency "httparty", "~> 0.16"
+end