vimeo_ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7000f9130237da5595d223c8a98598720a573a9be750378c37b6d1edb01080b2
-  data.tar.gz: dd9b26623d5bcf4bd80145f9acff65d00593cfdaa412c14f10629aa5f6fe87e2
+  metadata.gz: 1ed0fda96d5d2a68abd3abc83ad39b0687ed9346db340ff49e990d949657977a
+  data.tar.gz: 5b1cc75bf6d4955c859ab443ebb167dcd96bb9cd63c1cd7505206180aa1ab0aa
 SHA512:
-  metadata.gz: 21d841070b073578b3c492c4c6f539a926ba9d7c5fc20b2f2784e1155b81a7903d78e0e542c3cd5d1940997b192ae2f9cdab27625a0fe01b32271bae6fbd0d4c
-  data.tar.gz: 2c9b3fb0a8ddaa5df8cc5df83b0658048209d50fea2cf1ca605213cdc2f4ca5bc32ea5b0ffe9e2bccf514150e2c1f8cd3dec68ad8b552469969f5929857c8ec7
+  metadata.gz: 50aa3fb2068c01fcd2ce01d3cf09a33b56a08688f1ef7f8a118f5f2b99679576a65510849f398993fafbd7056954f8ad9f9400ec6c139971909370f787fa139c
+  data.tar.gz: 2354449f341d3e996e6488f65aa52e97425ed6bfa2003d011566050ae8f8096fe87b7b448ef7f8d6167e6eb1d0ac4451853d180f1608772b8936844681d5985f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vimeo_ruby (0.1.0)
+    vimeo_ruby (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,7 +1,14 @@
-# VimeoRuby
+# VimeoRuby 0.2.0
 
 Welcome to VimeoRuby!
 
+## Development Philosophy/Mindset
+
+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!
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -14,7 +21,82 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-WIP
+### 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
 

data/lib/vimeo_ruby/user/uploaded_video_collection.rb

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

data/lib/vimeo_ruby/user.rb

@@ -1,5 +1,5 @@
 module VimeoRuby
-  class User < VimeoRuby::Base
+  class User < Base
     attr_reader :vimeo_id, :available_for_hire, :bio, :can_work_remotely, :location, :name, :profile_link, :additional_info
 
     def initialize(attrs: {})
@@ -10,7 +10,7 @@ module VimeoRuby
       @location = attrs.delete("location")
       @name = attrs.delete("name")
       @profile_link = attrs.delete("link")
-      @additional_info = attrs
+      @additional_info = OpenStruct.new(attrs)
     end
 
     def self.get_user(user_id)
@@ -25,7 +25,7 @@ module VimeoRuby
     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"]
-      VimeoRuby::User::UploadedVideoCollection.new(uploaded_videos)
+      UploadedVideoCollection.new(uploaded_videos)
     end
 
     def available_for_hire?

data/lib/vimeo_ruby/version.rb

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

data/lib/vimeo_ruby/video.rb

@@ -1,5 +1,5 @@
 module VimeoRuby
-  class Video < VimeoRuby::Base
+  class Video < Base
     attr_reader :vimeo_id, :description, :duration, :embed_html, :link, :name, :player_embed_url, :type, :user, :additional_info
 
     def initialize(attrs: {})
@@ -12,7 +12,7 @@ module VimeoRuby
       @player_embed_url = attrs.delete("player_embed_url")
       @type = attrs.delete("type")
       @user = VimeoRuby::User.new(attrs: attrs.delete("user"))
-      @additional_info = attrs
+      @additional_info = OpenStruct.new(attrs)
     end
 
     def self.get_video(video_id)

data/lib/vimeo_ruby.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "vimeo_ruby/base"
 require "vimeo_ruby/user"
 require "vimeo_ruby/user/uploaded_video_collection"
@@ -8,4 +9,12 @@ require "vimeo_ruby/video"
 
 module VimeoRuby
   class Error < StandardError; end
+
+  def self.get_user(vimeo_id)
+    User.get_user(vimeo_id)
+  end
+
+  def self.get_video(vimeo_id)
+    Video.get_video(vimeo_id)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimeo_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Collin Jilbert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2022-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock