wistia-api 0.2.1 → 0.2.2

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.2@wistia-api
+rvm use 1.9.3@wistia-api --create

data/Gemfile

@@ -1,17 +1,14 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source 'http://rubygems.org'
 
 gem 'activeresource', '>= 2.3.8'
-gem 'configatron', '>= 2.6.4'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
+  gem 'bundler', '~> 1.2'
+  gem 'fakeweb', '~> 1.3'
+  gem 'jeweler', '~> 1.8'
+  gem 'rcov', '>= 0'
+  gem 'rspec', '~> 2.12'
 end
 

data/Gemfile.lock

@@ -10,34 +10,36 @@ GEM
       activesupport (= 3.0.3)
     activesupport (3.0.3)
     builder (2.1.2)
-    configatron (2.6.4)
-      yamler (>= 0.1.0)
-    diff-lcs (1.1.2)
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
     git (1.2.5)
     i18n (0.5.0)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.8.7)
+      rdoc
+    json (1.7.7)
+    rake (10.0.3)
     rcov (0.9.9)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    yamler (0.1.0)
+    rdoc (3.12.1)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activeresource (>= 2.3.8)
-  bundler (~> 1.0.0)
-  configatron (>= 2.6.4)
-  jeweler (~> 1.5.2)
+  bundler (~> 1.2)
+  fakeweb (~> 1.3)
+  jeweler (~> 1.8)
   rcov
-  rspec (~> 2.3.0)
+  rspec (~> 2.12)

data/README.md

@@ -0,0 +1,82 @@
+Wistia API
+==========
+
+Ruby wrapper for Wistia's API
+
+# Installation
+
+## Required gems:
+
+* activeresource >= 2.3.8
+
+## Install:
+
+    gem install wistia-api
+
+# Basic Usage
+
+Start by requiring wistia:
+
+    require 'wistia'
+
+Configure your API password:
+
+    Wistia.password = 'your-api-password-here'
+
+**NOTE:** [see the instructions for generating an API password](http://wistia.com/doc/data-api#getting_started)
+
+Now you can use the <tt>Wistia::Media</tt>, <tt>Wistia::Project</tt>, and <tt>Wistia::Projects::Sharing</tt> classes as ActiveResource wrappers around Wistia's API.
+
+See http://wistia.com/doc/data-api for more info.
+
+Configuration Options
+---------------------
+
+Set the format of the API:
+
+    Wistia.format = 'json'  # This is the default.
+    Wistia.format = 'xml'
+
+Read configuration from an external YAML file:
+
+    Wistia.use_config!(path_to_yaml)
+
+For an example YAML config, see spec/support/config.test.yml
+
+Configure using a Hash:
+
+    Wistia.use_config!(:wistia => {
+      :api => {
+        :password => 'your-api-password',
+        :format => 'xml-or-json'
+      }
+    })
+
+Examples
+--------
+
+List all Media in your account:
+
+    Wistia::Media.find(:all)
+
+List all Projects in your account:
+
+    Wistia::Project.find(:all)
+
+List all Sharing objects for project 23:
+
+    Wistia::Projects::Sharing.find(:all, :params => { :project_id => 23 })
+
+Get stats for a project since the December 1, 2012
+
+    Wistia::Stats::Project.get('efjh6kxmc9/by_date', :start_date => '2012-12-01')
+
+List Overall Stats for Your Account
+
+    Wistia::Stats::Account.find_singleton
+
+Copyright
+---------
+
+Copyright (c) 2011 Wistia, Inc. See LICENSE.txt for
+further details.

data/Rakefile

@@ -12,19 +12,13 @@ require 'rake'
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "wistia-api"
-  gem.homepage = "http://github.com/wistia/wistia-api"
-  gem.license = "MIT"
-  gem.summary = %Q{Ruby wrapper for Wistia's API}
-  gem.description = %Q{A ruby library for working with Wistia's data API.}
-  gem.email = "support@wistia.com"
-  gem.authors = ["Jim Bancroft", "Mark Bates"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-  gem.add_runtime_dependency 'activeresource', '>= 2.3.8'
-  gem.add_runtime_dependency 'configatron', '>= 2.6.4'
+  gem.name = 'wistia-api'
+  gem.homepage = 'http://github.com/wistia/wistia-api'
+  gem.license = 'MIT'
+  gem.summary = 'Ruby wrapper for Wistia\'s API'
+  gem.description = 'A ruby library for working with Wistia\'s data API.'
+  gem.email = 'support@wistia.com'
+  gem.authors = ['Jeff Vincent', 'Jim Bancroft', 'Mark Bates', 'Robby Grossman']
 end
 Jeweler::RubygemsDotOrgTasks.new
 
@@ -41,7 +35,7 @@ end
 
 task :default => :spec
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
@@ -50,4 +44,3 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/wistia/base.rb

@@ -1,21 +1,19 @@
-require File.join(File.dirname(__FILE__), 'config')
+require 'wistia/config'
 
 module Wistia
   class Base < ActiveResource::Base
-    # Resets all the ActiveResource configuration options to what's currently stored in the configatron.
+    self.site = Wistia::API_BASE_URL
+    self.user = 'api'
+
     def self.refresh_config!
-      self.site = Wistia::Config.config.api.url
-      self.user = Wistia::Config.config.api.user
-      self.password = Wistia::Config.config.api.key
-      self.format = Wistia::Config.config.api.format.to_sym
+      self.password = Wistia.password
+      self.format = ActiveResource::Formats::JsonFormat if Wistia.format == :json
+      self.format = ActiveResource::Formats::XmlFormat if Wistia.format == :xml
     end
-
     refresh_config!
-    
+
     def to_json(options = {})
-      return self.attributes.to_json(options)
+      self.attributes.to_json(options)
     end
-    
   end
 end
-

data/lib/wistia/config.rb

@@ -1,25 +1,62 @@
-module Wistia
-
-  class << self
-
-    def config(&block)
-      Wistia::Config.config(&block)
-    end
-
-  end
-
-  module Config
+require 'wistia/initialization'
 
-    class << self
-
-      def config(&block)
-        yield configatron.wistia if block_given?
-        configatron.wistia
+module Wistia
+  # Specifies a new configuration to use for the API.
+  # Accepts either a Hash or a String pointing to a YAML configuration file.
+  #
+  # Example using a Hash:
+  #   Wistia.use_config!(:wistia => { :api => { :key => 'your-api-key', :format => 'json-or-xml' } })
+  def self.use_config!(config)
+    if config.is_a?(String) && File.exists?(config) && File.extname(config) == '.yml'
+      self.use_config!(YAML.load_file(config))
+    elsif config.is_a?(Hash)
+      config = config.with_indifferent_access
+
+      if data_hash = config && config[:wistia] && config[:wistia][:api]
+        if data_hash[:key]
+          data_hash[:password] = data_hash[:key]
+          warn '[DEPRECATION] You have configured wistia-api authentication using the configuration key: "key".'
+          warn '              Please use the configuration key "password" instead (using the same value).'
+        end
+
+        new_password = data_hash[:password]
+        self.password = new_password unless new_password.nil?
+        new_format = data_hash[:format]
+        self.format = new_format.to_sym unless new_format.nil?
       end
-
+    else
+      raise ArgumentError, 'Invalid config'
     end
+  end
 
+  # Set your API password using this method.
+  # For instructions to find your API password, go here: http://wistia.com/doc/api-enable
+  def self.password= (new_password)
+    @@password = new_password
+    Wistia.refresh_config_for_wistia_api_objects!
+    @@password
   end
+  def self.password; @@password; end
+
+  # Set the format that the API uses to either 'json' or 'xml'.
+  # Accepts either a String or a Symbol.
+  def self.format=(new_format)
+    valid_formats = [:json, :xml]
+    raise ArgumentError, "Invalid format.  Supported formats: #{valid_formats.join(', ')}." unless valid_formats.include?(new_format.to_sym)
+    @@format = new_format
+    Wistia.refresh_config_for_wistia_api_objects!
+    @@format
+  end
+  def self.format; @@format; end
 
+  def self.wistia_api_objects
+    ObjectSpace.each_object(Class).select{|klass| klass < Wistia::Base} << Wistia::Base
+  end
+  def self.refresh_config_for_wistia_api_objects!
+    self.wistia_api_objects.each {|d| d.refresh_config!}
+  end
 end
 
+require 'wistia/base' # We want wistia/config to load before wistia/base, but we also want
+                      # to ensure wistia/base is loaded so that #wistia_api_objects and
+                      # refresh_config_for_wistia_api_objects! works.

data/lib/wistia/initialization.rb

@@ -0,0 +1,6 @@
+module Wistia
+  API_BASE_URL = 'https://api.wistia.com/v1/'
+
+  @@password = nil
+  @@format = :json
+end

data/lib/wistia/media.rb

@@ -1,6 +1,5 @@
 module Wistia
   class Media < Wistia::Base
-    
     self.collection_name = 'medias'
 
     def still(width = 640, options = {})
@@ -12,9 +11,8 @@ module Wistia
           return url
         end
       end
-      return nil
-    end
-
-  end # Media
-end # Wistia
 
+      nil
+    end
+  end
+end

data/lib/wistia/project.rb

@@ -1,5 +1,4 @@
 module Wistia
   class Project < Wistia::Base
-    
   end
-end
+end

data/lib/wistia/projects/sharing.rb

@@ -1,18 +1,11 @@
 module Wistia
   module Projects
     class Sharing < Wistia::Base
-        def self.refresh_config!
-          super
-          self.site = "#{Wistia::Config.config.api.url}projects/:project_id/"
-        end
-
-        refresh_config!
-        
-        def to_json(options = {})
-          return self.attributes.to_json(options)
-        end
+      self.site = "#{Wistia::API_BASE_URL}projects/:project_id/"
 
+      def to_json(options = {})
+        self.attributes.to_json(options)
+      end
     end
   end
 end
-

data/lib/wistia/stats.rb

@@ -0,0 +1,22 @@
+module Wistia
+  module Stats
+    class Base < Wistia::Base
+      self.site = "#{Wistia::API_BASE_URL}stats/"
+    end
+
+    class Account < Wistia::Stats::Base
+      # to make it easier to find singleton
+      def self.find_singleton
+        find :one, :from => '/v1/stats/account.json'
+      end
+    end
+    class Event < Wistia::Stats::Base
+    end
+    class Media < Wistia::Stats::Base
+    end
+    class Project < Wistia::Stats::Base
+    end
+    class Visitor < Wistia::Stats::Base
+    end
+  end
+end

data/lib/wistia.rb

@@ -1,56 +1,8 @@
-require 'config'
 require 'active_resource'
+require 'wistia/initialization'
+require 'wistia/config'
 require 'wistia/base'
 require 'wistia/media'
 require 'wistia/project'
 require 'wistia/projects/sharing'
-require 'wistia/stats/base'
-require 'wistia/stats/event'
-require 'wistia/stats/visitor'
-require 'wistia/stats/media'
-require 'wistia/stats/project'
-require 'wistia/stats/account'
-
-module Wistia
-
-  # Specifies a new configuration to use for the API.
-  # Accepts either a Hash or a String pointing to a YAML configuration file.
-  #
-  # Example using a Hash:
-  #   Wistia.use_config!(:wistia => { :api => { :key => 'your-api-key', :format => 'json-or-xml' } })
-  def self.use_config!(config)
-    if config.is_a?(String) && File.exists?(config) && File.extname(config) == '.yml'
-      configatron.configure_from_yaml(config)
-    elsif config.is_a?(Hash)
-      configatron.configure_from_hash(config)
-    else
-      raise ArgumentError, 'Invalid config'
-    end
-
-    refresh_config!
-  end
-
-  # Set your API password using this method.
-  # For instructions to find your API password, go here: http://wistia.com/doc/api-enable
-  def self.password=(pw)
-    use_config!(:wistia => { :api => { :key => pw } })
-  end
-
-  # Set the format that the API uses to either 'json' or 'xml'.
-  # Accepts either a String or a Symbol.
-  def self.format=(fmt)
-    valid_formats = [ :json, :xml ]
-    raise ArgumentError, "Invalid format.  Supported formats: #{valid_formats.join(', ')}." unless valid_formats.include?(fmt.to_sym)
-    use_config!(:wistia => { :api => { :format => fmt.to_sym } })
-  end
-
-  # Force each ActiveResource descendant to re-read its configuration from the configatron.
-  def self.refresh_config!
-    Wistia::Media.refresh_config!
-    Wistia::Project.refresh_config!
-    Wistia::Projects::Sharing.refresh_config!
-    Wistia::Stats::Base.refresh_config!
-  end
-
-end
-
+require 'wistia/stats'

data/spec/spec_helper.rb

@@ -1,12 +1,20 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
+require 'fakeweb'
 require 'wistia'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
-RSpec.configure do |config|
-  
+RSpec.configuration.before :each do
+  # Disallow real web connections; run each time in case a test overrides it.
+  FakeWeb.allow_net_connect = false
+
+  # Simulate a clean Wistia class for each spec
+  [:@@password, :@@format].each do |class_var|
+    Wistia.remove_class_variable(class_var) if Wistia.class_variable_defined?(class_var)
+    Wistia.class_variable_set class_var, nil
+  end
 end

data/spec/support/config.test.yml

@@ -1,6 +1,4 @@
 wistia:
   api:
     key: 'test'
-    user: 'api'
     format: 'json'
-    url: 'http://api.wistia.local:3000/v1/'

data/spec/wistia/base_spec.rb

@@ -1,28 +1,30 @@
-require 'spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-module Wistia
-  describe Base do
-    describe 'refresh_config!' do
-      it 'sets the "site" public class attribute' do
-        Wistia::Base.should_receive(:site=)
-        Wistia::Base.refresh_config!
-      end
-
-      it 'sets the "user" public class attribute' do
-        Wistia::Base.should_receive(:user=)
-        Wistia::Base.refresh_config!
-      end
-
-      it 'sets the "password" public class attribute' do
-        Wistia::Base.should_receive(:password=)
-        Wistia::Base.refresh_config!
-      end
-
-      it 'sets the "format" public class attribute' do
-        Wistia::Base.should_receive(:format=)
-        Wistia::Base.refresh_config!
-      end
+describe Wistia::Base do
+  describe 'authentication' do
+    it 'sets user to "api"' do
+      Wistia::Base.user.should == 'api'
+    end
+    it 'sets password based on config' do
+      Wistia.password = 'foo'
+      Wistia::Base.password.should == 'foo'
+    end
+  end
+  describe 'self#refresh_config!' do
+    it 'updates the configuration for the class' do
+      Wistia.password = 'bar'
+      Wistia::Base.password = 'foo'
+      Wistia::Base.password.should == 'foo'
+      Wistia::Base.refresh_config!
+      Wistia::Base.password.should == 'bar'
+    end
+  end
+  describe '#to_json' do
+    it 'renders attributes in json format' do
+      b = Wistia::Base.new
+      b.key1 = 'val1'
+      b.key2 = 'val2'
+      JSON.parse(b.to_json).should == {'key1' => 'val1', 'key2' => 'val2'}
     end
   end
 end
-

data/spec/wistia/config_spec.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Wistia do
+  describe 'self#wistia_api_objects' do
+    it 'returns array of classes that inherit from Wistia::Base' do
+      expected_descendants = [
+        Wistia::Base,
+        Wistia::Media,
+        Wistia::Project,
+        Wistia::Projects::Sharing,
+        Wistia::Stats::Base,
+        Wistia::Stats::Account,
+        Wistia::Stats::Media,
+        Wistia::Stats::Event,
+        Wistia::Stats::Project,
+        Wistia::Stats::Visitor,
+      ]
+
+      expected_descendants.each {|ed| Wistia.wistia_api_objects.should include(ed)}
+      Wistia.wistia_api_objects.count.should == expected_descendants.count
+    end
+  end
+
+  describe 'use_config!' do
+    context 'given a hash argument' do
+      it 'sets the password from the hash' do
+        Wistia.password.should be_nil
+        Wistia.use_config!( :wistia => { :api => { :password => 'test' } } )
+        Wistia.password.should == 'test'
+      end
+      it 'sets the password from the hash when supplied as \'key\'' do
+        Wistia.password.should be_nil
+        Wistia.use_config!( :wistia => { :api => { :key => 'test' } } )
+        Wistia.password.should == 'test'
+      end
+      it 'sets the format in symbolic form from the hash' do
+        Wistia.format.should be_nil
+        Wistia.use_config!( :wistia => { :api => { :format => 'xml' } } )
+        Wistia::Base.format.should == ActiveResource::Formats::XmlFormat
+        Wistia.format.should == :xml
+        Wistia.use_config!( :wistia => { :api => { :format => 'json' } } )
+        Wistia::Base.format.should == ActiveResource::Formats::JsonFormat
+        Wistia.format.should == :json
+      end
+      it 'leaves format alone when setting only password' do
+        Wistia.format = :xml
+        Wistia.use_config!( :wistia => { :api => { :password => 'foo' } } )
+        Wistia.format.should == :xml
+      end
+      it 'leaves password alone when setting only format' do
+        Wistia.password = 'foo'
+        Wistia.use_config!( :wistia => { :api => { :format => 'xml' } } )
+        Wistia.password.should == 'foo'
+      end
+    end
+
+    context 'given a path to a yaml file' do
+      it 'uses the yaml file for configuration' do
+        path_to_yaml = File.dirname(__FILE__) + '/../support/config.test.yml'
+        Wistia.use_config!(path_to_yaml)
+        Wistia.password.should == 'test'
+        Wistia.format.should == :json
+      end
+    end
+
+    context 'given an invalid config' do
+      it 'raises an ArgumentError' do
+        lambda {
+          Wistia.use_config!(nil)
+        }.should raise_error(ArgumentError, 'Invalid config')
+      end
+    end
+  end
+end

data/spec/wistia/media_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Wistia::Media do
+  it 'finds the media' do
+    FakeWeb.register_uri :get, 'https://api:foo@api.wistia.com/v1/medias/7.json', body: {name: 'object name'}.to_json
+    Wistia.password = 'foo'
+    Wistia.format = :json
+    Wistia::Media.find(7).name.should == 'object name'
+  end
+end

data/spec/wistia/project_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Wistia::Project do
+  it 'finds the project' do
+    FakeWeb.register_uri :get, 'https://api:foo@api.wistia.com/v1/projects/7.json', body: {name: 'object name'}.to_json
+    Wistia.password = 'foo'
+    Wistia.format = :json
+    Wistia::Project.find(7).name.should == 'object name'
+  end
+end