vimeorb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c78e0691674c67ddd260b6fcd7bfdaa63969b4ac607a407c0e2db0cf2764faf
+  data.tar.gz: 0fd974c57a0cb41d2ef89a4a170334d50400942ab8c746a9234c292d73e4f345
+SHA512:
+  metadata.gz: '0649be4eaf989d832a1efb509b0a2790493fe2e44b60f736c26ed8ebd7eed61d8d01672e06ece5c124d7bfdffb4e4abdd3b55a0f2fc5ad61577a80632710c295'
+  data.tar.gz: 92e3d0c5477479f34a8cf268cfbfd8f846edf964a595411b117f2593039bdcb8788179c0bc8941f4adfce2c3dc9ac352322a56be94e9d404f61d546c9c5bb08f

data/.env.example

@@ -0,0 +1 @@
+ACCESS_TOKEN=

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in youtuberb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "dotenv"

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    vimeorb (0.1.1)
+      faraday (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (2.2.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.2)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  rake (~> 13.0)
+  vimeorb!
+
+BUNDLED WITH
+   2.3.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dean Perry
+
+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,46 @@
+# VimeoRB
+
+**This library is a work in progress**
+
+VimeoRB is a Ruby library for interacting with the Vimeo v3.4 API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vimeorb'
+```
+
+## Usage
+
+### Set Client Details
+
+Firstly you'll need to set an Access Token. 
+An Access Token will be an OAuth2 token generated after authentication. 
+
+```ruby
+@client = Vimeo::Client.new(access_token: "")
+```
+
+### Videos
+
+```ruby
+# Retrieve a Video's details
+@client.videos.retrieve(id: "abc123")
+
+# Edit a Video
+params = {title: "New Title"}
+@client.videos.edit(id: "abc123", params)
+
+# Delete a Video
+@client.videos.delete(id: "abc123")
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/vimeorb.
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "vimeo"
+
+# Load environment variables from .env file
+require 'dotenv/load'
+
+# 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
+
+@client = Vimeo::Client.new(access_token: ENV["ACCESS_TOKEN"])
+
+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/lib/vimeo/client.rb

@@ -0,0 +1,31 @@
+module Vimeo
+  class Client
+    BASE_URL = "https://api.vimeo.com"
+
+    attr_reader :access_token, :adapter
+
+    def initialize(access_token:, adapter: Faraday.default_adapter, stubs: nil)
+      @access_token = access_token
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def videos
+      VideosResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :authorization, :Bearer, access_token
+        conn.request :json
+
+        conn.response :json
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+  end
+end

data/lib/vimeo/collection.rb

@@ -0,0 +1,24 @@
+module Vimeo
+  class Collection
+    attr_reader :data, :total, :next_page_token, :prev_page_token
+
+    def self.from_response(response, type:)
+      body = response.body
+
+      new(
+        data: body["items"].map { |attrs| type.new(attrs) },
+        total: body["pageInfo"]["totalResults"],
+        next_page_token: body["nextPageToken"],
+        prev_page_token: body["prevPageToken"],
+        # cursor: body.dig("pagination", "cursor")
+      )
+    end
+
+    def initialize(data:, total:, next_page_token:, prev_page_token:)
+      @data = data
+      @total = total
+      @next_page_token = next_page_token
+      @prev_page_token = prev_page_token
+    end
+  end
+end

data/lib/vimeo/error.rb

@@ -0,0 +1,4 @@
+module Vimeo
+  class Error < StandardError
+  end
+end

data/lib/vimeo/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Vimeo
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/vimeo/objects/video.rb

@@ -0,0 +1,11 @@
+module Vimeo
+  class Video < Object
+
+    def initialize(options = {})
+      super options
+
+      self.id = options["uri"].gsub("/videos/", "")
+    end
+
+  end
+end

data/lib/vimeo/resource.rb

@@ -0,0 +1,56 @@
+module Vimeo
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Error 400: Your request was malformed. '#{response.body["error"]}'"
+      when 401
+        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["error"]["message"]}'"
+      when 403
+        raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["error"]["message"]}'"
+      when 404
+        raise Error, "Error 404: No results were found for your request. '#{response.body["error"]["message"]}'"
+      when 409
+        raise Error, "Error 409: Your request was a conflict. '#{response.body["error"]["message"]}'"
+      when 429
+        raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error"]["message"]}'"
+      when 500
+        raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["error"]["message"]}'"
+      when 503
+        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["error"]["message"]}'"
+      when 204
+        return true
+      end
+
+      response
+    end
+  end
+end

data/lib/vimeo/resources/videos.rb

@@ -0,0 +1,20 @@
+module Vimeo
+  class VideosResource < Resource
+
+    def retrieve(id:)
+      response = get_request("videos/#{id}")
+      Video.new(response.body)
+    end
+    
+    def edit(id:, **params)
+      response = patch_request("videos/#{id}", body: params)
+      Video.new(response.body)
+    end
+
+    def delete(id:)
+      response = delete_request("videos/#{id}")
+      return true if response.success
+    end
+
+  end
+end

data/lib/vimeo/version.rb

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

data/lib/vimeo.rb

@@ -0,0 +1,18 @@
+require "faraday"
+require "json"
+
+require_relative "vimeo/version"
+
+module Vimeo
+
+  autoload :Client, "vimeo/client"
+  autoload :Collection, "vimeo/collection"
+  autoload :Error, "vimeo/error"
+  autoload :Resource, "vimeo/resource"
+  autoload :Object, "vimeo/object"
+
+  autoload :VideosResource, "vimeo/resources/videos"
+
+  autoload :Video, "vimeo/objects/video"
+
+end

data/lib/vimeorb.rb

@@ -0,0 +1 @@
+require "vimeo"

data/vimeorb.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/vimeo/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "vimeorb"
+  spec.version = Vimeo::VERSION
+  spec.authors = ["Dean Perry"]
+  spec.email = ["dean@deanpcmad.com"]
+
+  spec.summary = "A Ruby library for interacting with the Vimeo API"
+  spec.homepage = "https://deanpcmad.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/vimeorb"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 2.0"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: vimeorb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vimeo.rb
+- lib/vimeo/client.rb
+- lib/vimeo/collection.rb
+- lib/vimeo/error.rb
+- lib/vimeo/object.rb
+- lib/vimeo/objects/video.rb
+- lib/vimeo/resource.rb
+- lib/vimeo/resources/videos.rb
+- lib/vimeo/version.rb
+- lib/vimeorb.rb
+- vimeorb.gemspec
+homepage: https://deanpcmad.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deanpcmad.com
+  source_code_uri: https://github.com/deanpcmad/vimeorb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: A Ruby library for interacting with the Vimeo API
+test_files: []