vimeo_ruby 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d06b7f4e83dc3ddb9c40c420d18a7b707fb273bb9e8491cca92b20ded84c456d
-  data.tar.gz: bc4fdd727846ed4499a8ac03931de9b190e26e6928be6ae14fbeaf3a6d424aec
+  metadata.gz: 1ed0fda96d5d2a68abd3abc83ad39b0687ed9346db340ff49e990d949657977a
+  data.tar.gz: 5b1cc75bf6d4955c859ab443ebb167dcd96bb9cd63c1cd7505206180aa1ab0aa
 SHA512:
-  metadata.gz: 54271f8b1c668b26158d29ce599397033124fb7cef4030d1e173d1fc0ed0c7ce5b75875501bb7943f663edc222e77d3260ce2f3f291742989533b164ab6c25d4
-  data.tar.gz: 2acaf5c8ed60d72854106df961ec08a5cab30082f4788c6dcc17e8382a7a33bb153cd75b9e28e20539d82d59b9570bcfb8538a22d36b8ee7db41be0e143b5250
+  metadata.gz: 50aa3fb2068c01fcd2ce01d3cf09a33b56a08688f1ef7f8a118f5f2b99679576a65510849f398993fafbd7056954f8ad9f9400ec6c139971909370f787fa139c
+  data.tar.gz: 2354449f341d3e996e6488f65aa52e97425ed6bfa2003d011566050ae8f8096fe87b7b448ef7f8d6167e6eb1d0ac4451853d180f1608772b8936844681d5985f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2022-12-28
+
+- Initial User and Video classes, with beginning interface to retrieve records from the Vimeo API. Adds a connection class used to hold a collection of a users uploaded videos (VimeoRuby::User::UploadedVideoCollection) accessible by calling `VimeoRuby::User#uploaded_videos`.
+
 ## [0.1.0] - 2022-12-25
 
 - Initial release

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    vimeo_ruby (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    hashdiff (1.0.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.40.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.20.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.40.0)
+      rubocop-performance (= 1.15.1)
+    unicode-display_width (2.3.0)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  standard (~> 1.3)
+  vcr (~> 6.1)
+  vimeo_ruby!
+  webmock (~> 3.18, >= 3.18.1)
+
+BUNDLED WITH
+   2.4.1

data/README.md

@@ -1,34 +1,122 @@
-# VimeoRuby
+# VimeoRuby 0.2.0
 
-TODO: Delete this and the text below, and describe your gem
+Welcome to VimeoRuby!
 
-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/vimeo_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Development Philosophy/Mindset
 
-## Installation
+The mindset of this project at this stage of development is to:
+1. Be simple - Write boring code, resist pulling in additional gems as much as possible, and don't worry about edge cases or handling errors all that much right now.
+2. Try to be as object-oriented as possible. I'm not an OO expert and you don't have to be either but let's try to improve our OO skills.
+3. Have fun. Who wants another job? Not me so let's keep it light and make something cool!
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add vimeo_ruby
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install vimeo_ruby
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configure Credentials
+
+First, make sure you have a Vimeo account and have access to the following credentials from your Vimeo [My Apps dashboard](https://developer.vimeo.com/apps):
+
+`access_token`, `client_identifier`, and `client_secret`
+
+Once you have access to these, assign them to the following environment variables accordingly:
+
+```ruby
+VIMEO_ACCESS_TOKEN=<access_token_value>
+VIMEO_CLIENT_IDENTIFIER=<client_identifier_value>
+VIMEO_CLIENT_SECRET=<client_secrete_value
+```
+
+Now you should be ready to continue onward and experiment with this first iteration of the gem interface.
+
+Currently there are two main classes the you should use to interface with the Vimeo API through which are `VimeoRuby::User` and `VimeoRuby::Video`.
+
+### Working with the VimeoRuby::User class
+
+For example, should you want to find a particular Vimeo user by their `vimeo_id`, you can make the following call:
+```ruby
+vimeo_user = VimeoRuby::User.get_user(<vimeo_id>) # Makes http request to the Vimeo API
+#=> #<VimeoRuby::User:0x000000011230df50
+```
+
+Alternatively, you can call the `get_user` method on the `VimeoRuby` module itself if you wish for something a bit shorter:
+```ruby
+vimeo_user = VimeoRuby.get_user(<vimeo_id>) # Makes http request to the Vimeo API
+#=> #<VimeoRuby::User:0x000000011230df50
+```
+
+With the `VimeoRuby::User` instance that was returned from the successful call we can see what methods are available by running the preceeding and the following code in an irb session with the gem loaded:
+```ruby
+vimeo_user.methods.sort - Object.methods
+=>  [:additional_info,
+     :available_for_hire,
+     :available_for_hire?,
+     :base_uri,
+     :bio,
+     :can_work_remotely,
+     :can_work_remotely?,
+     :location,
+     :profile_link,
+     :uploaded_videos,
+     :vimeo_id]
+```
+
+We can then take the `vimeo_user` that we currently have stored and retrieve a collection of all of the users uploaded videos with the following:
+```ruby
+uploaded_video_collection = vimeo_user.uploaded_videos # Makes http request to the Vimeo API
+# => #<VimeoRuby::User::UploadedVideoCollection:0x00000001130e98b8
+```
+
+The `VimeoRuby::User::UploadedVideoCollection` object stores an array of `VimeoRuby::Video` objects which are accessible by calling:
+```ruby
+uploaded_video_collection.videos # No http request is made to the Vimeo API
+#=> [#<VimeoRuby::Video:0x0000000112fb3228
+#     ....,
+#     ....,
+#    ]
+```
+
+### Working with the VimeoRuby::Video class
+
+To retrieve a particular video from Vimeo you can use the following call:
+```ruby
+vimeo_video = VimeoRuby::Video.get_video(<vimeo_id>)
+#=> #<VimeoRuby::Video:0x000000022341eg61
+```
+
+Alternatively, you can call the `get_video` method on the `VimeoRuby` module itself if you wish for something a bit shorter:
+```ruby
+vimeo_video = VimeoRuby.get_video(<vimeo_id>) # Makes http request to the Vimeo API
+#=> #<VimeoRuby::Video:0x0000000223gc4339
+```
 
 ## Development
 
+At the moment, you will need to create a Vimeo account to obtain your own `access_token`, `client_identifier`, and `client_secret` if you wish to work on building out an interface to any of the Vimeo API endpoints.
+Will be working on a solution to remedy this step in the future but for now, after obtaining these, set the values to the following env vars on your local machine accordingly:
+- `VIMEO_ACCESS_TOKEN`
+- `VIMEO_CLIENT_IDENTIFIER`
+- `VIMEO_CLIENT_SECRET`
+
 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+### Maintainers only
+
+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 the created tag, 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]/vimeo_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/vimeo_ruby/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/cjilbert504/vimeo_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/cjilbert504/vimeo_ruby/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +124,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the VimeoRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/vimeo_ruby/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the VimeoRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cjilbert504/vimeo_ruby/blob/main/CODE_OF_CONDUCT.md).

data/lib/vimeo_ruby/base.rb

@@ -0,0 +1,43 @@
+require "json"
+require "net/http"
+
+module VimeoRuby
+  class Base
+    class << self
+      def base_uri
+        "https://api.vimeo.com"
+      end
+
+      def access_token
+        ENV["VIMEO_ACCESS_TOKEN"]
+      end
+
+      def client_identifier
+        ENV["VIMEO_CLIENT_IDENTIFIER"]
+      end
+
+      def client_secret
+        ENV["VIMEO_CLIENT_SECRET"]
+      end
+
+      def get(uri, query_params: {})
+        uri = URI.parse(uri)
+        uri.query = URI.encode_www_form(query_params)
+
+        Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |https|
+          request = Net::HTTP::Get.new(uri)
+          request.basic_auth(client_identifier, client_secret)
+
+          response = https.request(request)
+          JSON.parse(response.body)
+        end
+      end
+    end
+
+    private
+
+    def extract_vimeo_id_from_uri(vimeo_uri)
+      vimeo_uri.match(/\d+/)[0].to_i
+    end
+  end
+end

data/lib/vimeo_ruby/user/uploaded_video_collection.rb

@@ -0,0 +1,13 @@
+module VimeoRuby
+  class User < Base
+    class UploadedVideoCollection
+      attr_reader :videos
+
+      def initialize(videos_array)
+        @videos = videos_array.map do |video_data|
+          Video.new(attrs: video_data)
+        end
+      end
+    end
+  end
+end

data/lib/vimeo_ruby/user.rb

@@ -0,0 +1,39 @@
+module VimeoRuby
+  class User < Base
+    attr_reader :vimeo_id, :available_for_hire, :bio, :can_work_remotely, :location, :name, :profile_link, :additional_info
+
+    def initialize(attrs: {})
+      @vimeo_id = extract_vimeo_id_from_uri(attrs.delete("uri"))
+      @available_for_hire = attrs.delete("available_for_hire")
+      @bio = attrs.delete("bio")
+      @can_work_remotely = attrs.delete("can_work_remotely")
+      @location = attrs.delete("location")
+      @name = attrs.delete("name")
+      @profile_link = attrs.delete("link")
+      @additional_info = OpenStruct.new(attrs)
+    end
+
+    def self.get_user(user_id)
+      user_info = get("#{base_uri}/users/#{user_id}")
+      new(attrs: user_info)
+    end
+
+    def base_uri
+      self.class.base_uri
+    end
+
+    def uploaded_videos(query_params: {})
+      uploaded_videos_response = self.class.get("#{base_uri}/users/#{vimeo_id}/videos", query_params: query_params)
+      uploaded_videos = uploaded_videos_response["data"]
+      UploadedVideoCollection.new(uploaded_videos)
+    end
+
+    def available_for_hire?
+      @available_for_hire
+    end
+
+    def can_work_remotely?
+      @can_work_remotely
+    end
+  end
+end

data/lib/vimeo_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VimeoRuby
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/vimeo_ruby/video.rb

@@ -0,0 +1,23 @@
+module VimeoRuby
+  class Video < Base
+    attr_reader :vimeo_id, :description, :duration, :embed_html, :link, :name, :player_embed_url, :type, :user, :additional_info
+
+    def initialize(attrs: {})
+      @vimeo_id = extract_vimeo_id_from_uri(attrs.delete("uri"))
+      @description = attrs.delete("description")
+      @duration = attrs.delete("duration")
+      @embed_html = attrs.delete("embed").delete("html")
+      @link = attrs.delete("link")
+      @name = attrs.delete("name")
+      @player_embed_url = attrs.delete("player_embed_url")
+      @type = attrs.delete("type")
+      @user = VimeoRuby::User.new(attrs: attrs.delete("user"))
+      @additional_info = OpenStruct.new(attrs)
+    end
+
+    def self.get_video(video_id)
+      video_info = get("#{base_uri}/videos/#{video_id}")
+      new(attrs: video_info)
+    end
+  end
+end

data/lib/vimeo_ruby.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require "net/http"
-require_relative "vimeo_ruby/version"
+require "ostruct"
+require "vimeo_ruby/base"
+require "vimeo_ruby/user"
+require "vimeo_ruby/user/uploaded_video_collection"
+require "vimeo_ruby/version"
+require "vimeo_ruby/video"
 
 module VimeoRuby
   class Error < StandardError; end
 
-  class Vimeo
-    attr_reader :base_uri
+  def self.get_user(vimeo_id)
+    User.get_user(vimeo_id)
+  end
 
-    def initialize
-      @base_uri = URI("https://api.vimeo.com/tutorial")
-    end
-
-    def tutorial_request
-      Net::HTTP.get_response(base_uri, { "Authorization": "bearer #{ENV["VIMEO_ACCESS_TOKEN"]}" })
-    end
-  end 
+  def self.get_video(vimeo_id)
+    Video.get_video(vimeo_id)
+  end
 end

data/vimeo_ruby.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/vimeo_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "vimeo_ruby"
+  spec.version = VimeoRuby::VERSION
+  spec.authors = ["Collin Jilbert"]
+  spec.email = ["cjilbert504@gmail.com"]
+
+  spec.summary = "A Ruby gem for interacting with the Vimeo API"
+  spec.description = "A Ruby gem for interacting with the Vimeo API"
+  spec.homepage = "https://github.com/cjilbert504/vimeo_ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/cjilbert504/vimeo_ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/cjilbert504/vimeo_ruby/blob/main/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  spec.add_development_dependency "webmock", "~> 3.18", ">= 3.18.1"
+  spec.add_development_dependency "vcr", "~> 6.1"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,15 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: vimeo_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Collin Jilbert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
-dependencies: []
+date: 2022-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 description: A Ruby gem for interacting with the Vimeo API
 email:
 - cjilbert504@gmail.com
@@ -21,12 +55,18 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/vimeo_ruby.rb
+- lib/vimeo_ruby/base.rb
+- lib/vimeo_ruby/user.rb
+- lib/vimeo_ruby/user/uploaded_video_collection.rb
 - lib/vimeo_ruby/version.rb
+- lib/vimeo_ruby/video.rb
 - sig/vimeo_ruby.rbs
+- vimeo_ruby.gemspec
 homepage: https://github.com/cjilbert504/vimeo_ruby
 licenses:
 - MIT