audio_vision 1.0.0.rc1

data/spec/lib/audio_vision/asset_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe AudioVision::Asset do
+  it 'is a representation of the Asset JSON' do
+    asset = AudioVision::Asset.new({
+      "title" => "02 - DCFS Night Shift",
+      "caption" => "Social worker Gesenia Macias leaves an apartment with two police officers after unsuccessfully trying to find the parents in a reported neglect case. ",
+      "owner" => "Grant Slater/KPCC",
+      "thumbnail" => {
+        "url" => "http://a.scpr.org/i/2ee96431ba36e1985a12c3212db6ee20/71930-lsquare.jpg",
+        "width" => 188,
+        "height" => 188
+      },
+      "small" => {
+        "url" => "http://a.scpr.org/i/2ee96431ba36e1985a12c3212db6ee20/71930-small.jpg",
+        "width" => 450,
+        "height" => 300
+      },
+      "large" => {
+        "url" => "http://a.scpr.org/i/2ee96431ba36e1985a12c3212db6ee20/71930-eight.jpg",
+        "width" => 729,
+        "height" => 486
+      },
+      "full" => {
+        "url" => "http://a.scpr.org/i/2ee96431ba36e1985a12c3212db6ee20/71930-full.jpg",
+        "width" => 1024,
+        "height" => 682
+      }
+    })
+
+    asset.caption.should eq "Social worker Gesenia Macias leaves an apartment with two police officers after unsuccessfully trying to find the parents in a reported neglect case. "
+    asset.owner.should eq "Grant Slater/KPCC"
+    asset.title.should eq "02 - DCFS Night Shift"
+
+    asset.thumbnail.should be_a AudioVision::Asset::Size
+    asset.small.should be_a AudioVision::Asset::Size
+    asset.large.should be_a AudioVision::Asset::Size
+    asset.full.should be_a AudioVision::Asset::Size
+  end
+
+
+  describe AudioVision::Asset::Size do
+    it "is a representation of the asset size JSON" do
+      size = AudioVision::Asset::Size.new({
+        "url" => "http://a.scpr.org/i/2ee96431ba36e1985a12c3212db6ee20/71930-full.jpg",
+        "width" => 1024,
+        "height" => 682
+      })
+
+      size.width.should eq 1024
+      size.height.should eq 682
+      size.url.should eq "http://a.scpr.org/i/2ee96431ba36e1985a12c3212db6ee20/71930-full.jpg"
+    end
+  end
+end

data/spec/lib/audio_vision/attribution_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe AudioVision::Attribution do
+  it "is a representation of the Attribution JSON object" do
+    attribution = AudioVision::Attribution.new(
+      {
+        "name" => "Grant Slater",
+        "url" => "http://audiovision.scpr.org/about/grant-slater",
+        "role_text" => "Author",
+        "role" => 1
+      }
+    )
+
+    attribution.name.should eq "Grant Slater"
+    attribution.url.should eq "http://audiovision.scpr.org/about/grant-slater"
+    attribution.role_text.should eq "Author"
+    attribution.role.should eq 1
+  end
+end

data/spec/lib/audio_vision/billboard_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe AudioVision::Billboard do
+  describe '::api_path' do
+    it "is the API path for the class" do
+      AudioVision::Billboard.api_path.should eq "/api/v1/billboards"
+    end
+  end
+
+
+  describe '::find' do
+    it 'returns the object if it is found' do
+      respond_with("billboard1_v1.json", uri: %r|api/v1/billboards|)
+
+      billboard = AudioVision::Billboard.find(1)
+      billboard.should be_a AudioVision::Billboard
+      billboard.id.should eq 'billboard-1'
+    end
+
+    it 'is false if nothing is found' do
+      respond_with(nil, {
+        :uri      => %r|api/v1/billboards|,
+        :body     => { error: "Not Found" },
+        :status   => 404
+      })
+
+      AudioVision::Billboard.find(999).should eq false
+    end
+  end
+
+
+  describe '::collection' do
+    it "returns an array of objects" do
+      respond_with("billboards_v1.json", uri: %r|api/v1/billboards|)
+
+      billboards = AudioVision::Billboard.collection
+      billboards.size.should eq 1
+    end
+  end
+
+
+  describe '::current' do
+    it 'finds the current billboard' do
+      respond_with("billboard1_v1.json", uri: %r|api/v1/billboards/current|)
+
+      billboard = AudioVision::Billboard.current
+      billboard.should be_a AudioVision::Billboard
+      billboard.id.should eq "billboard-1"
+    end
+
+    it "is nil if nothing found" do
+      respond_with(nil, {
+        :uri      => %r|api/v1/billboards/current|,
+        :body     => { error: "Not Found" },
+        :status   => 404
+      })
+ 
+      AudioVision::Billboard.current.should eq nil
+    end
+  end
+
+
+  describe 'initialization' do
+    it 'makes a new Billboard object' do
+      t = Time.now
+
+      billboard = AudioVision::Billboard.new({
+        "id"              => "billboard-1",
+        "published_at"    => t.to_s
+      })
+
+      billboard.id.should eq "billboard-1"
+      billboard.published_at.to_s.should eq t.to_s
+      billboard.posts.should eq Array.new
+    end
+  end
+end

data/spec/lib/audio_vision/bucket_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe AudioVision::Bucket do
+  describe '::api_path' do
+    it "is the API path for the class" do
+      AudioVision::Bucket.api_path.should eq "/api/v1/buckets"
+    end
+  end
+
+
+  describe '::find' do
+    it 'returns the object if it is found' do
+      respond_with("bucket_v1.json", uri: %r|api/v1/buckets|)
+
+      bucket = AudioVision::Bucket.find("featured-posts")
+      bucket.should be_a AudioVision::Bucket
+      bucket.id.should eq 'featured-posts'
+    end
+
+    it 'is false if nothing is found' do
+      respond_with(nil, {
+        :uri      => %r|api/v1/buckets|,
+        :body     => { error: "Not Found" },
+        :status   => 404
+      })
+
+      AudioVision::Bucket.find(999).should eq false
+    end
+  end
+
+
+  describe '::collection' do
+    it "returns an array of objects" do
+      respond_with("buckets_v1.json", uri: %r|api/v1/buckets|)
+
+      buckets = AudioVision::Bucket.collection
+      buckets.size.should eq 4
+    end
+  end
+
+
+  describe '::find_by_key' do
+    it 'finds the bucket if available' do
+      respond_with("bucket_v1.json", uri: %r|api/v1/buckets|)
+
+      bucket = AudioVision::Bucket.find_by_key('featured-posts')
+      bucket.should be_a AudioVision::Bucket
+      bucket.id.should eq "featured-posts"
+    end
+
+    it "is false if nothing found" do
+      respond_with(nil, {
+        :uri      => %r|api/v1/buckets|,
+        :body     => { error: "Not Found" },
+        :status   => 404
+      })
+      
+      AudioVision::Bucket.find_by_key("lolnope").should eq false
+    end
+  end
+
+
+  describe 'initialization' do
+    it 'makes a new Bucket object' do
+      bucket = AudioVision::Bucket.new({
+        "id"            => "featured-posts",
+        "updated_at"    => Time.now.to_s
+      })
+
+      bucket.id.should eq "featured-posts"
+      bucket.posts.should eq Array.new
+    end
+  end
+end

data/spec/lib/audio_vision/category_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe AudioVision::Category do
+  it "is a representation of the Category JSON object" do
+    category = AudioVision::Category.new(
+      {
+        "id" => 2,
+        "title" => "Images",
+        "slug" => "images",
+        "description" => "The heartbeat of AudioVision. The best from our team of photojournalists — and discover images from the photographers who inspire them.",
+        "public_url" => "http://audiovision.scpr.org/images",
+        "permalink" => "http://audiovision.scpr.org/images"
+      }
+    )
+
+    category.id.should eq 2
+    category.title.should eq "Images"
+    category.slug.should eq "images"
+    category.description.should eq "The heartbeat of AudioVision. The best from our team of photojournalists — and discover images from the photographers who inspire them."
+    category.public_url.should eq "http://audiovision.scpr.org/images"
+  end
+end

data/spec/lib/audio_vision/client_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe AudioVision::Client do
+  describe '#get' do
+    it 'fires a GET request to the API' do
+      respond_with("post_v1.json", uri: "http://audiovision.scpr.org/api/v1/posts/1")
+      client = AudioVision::Client.new
+
+      response = client.get("posts/1")
+      response.should be_a Faraday::Response
+      response.body["id"].should eq "post-104"
+    end
+  end
+end

data/spec/lib/audio_vision/post_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe AudioVision::Post do
+  describe '::api_path' do
+    it "is the API path for the class" do
+      AudioVision::Post.api_path.should eq "/api/v1/posts"
+    end
+  end
+
+
+  describe '::find' do
+    it 'returns the object if it is found' do
+      respond_with("post_v1.json", uri: %r|api/v1/posts|)
+
+      post = AudioVision::Post.find(104)
+      post.should be_a AudioVision::Post
+      post.id.should eq 'post-104'
+    end
+
+    it 'is false if nothing is found' do
+      respond_with(nil, {
+        :uri      => %r|api/v1/posts|,
+        :body     => { error: "Not Found" },
+        :status   => 404
+      })
+
+      AudioVision::Post.find(999).should eq false
+    end
+  end
+
+
+  describe '::collection' do
+    it "returns an array of objects" do
+      respond_with("posts_v1.json", uri: %r|api/v1/posts|)
+
+      posts = AudioVision::Post.collection
+      posts.size.should eq 2
+    end
+
+    it "accepts options" do
+      respond_with("posts_images_v1.json", uri: %r|api/v1/posts\?category=images|)
+      posts = AudioVision::Post.collection(category: "images")
+      posts.first.id.should eq "post-321"
+    end
+  end
+
+
+  describe '::find_by_url' do
+    it "finds the post" do
+      respond_with("post_v1.json", uri: %r|api/v1/posts|)
+
+      post = AudioVision::Post.find_by_url("http://audiovision.scpr.org/posts/104")
+      post.should be_a AudioVision::Post
+      post.id.should eq "post-104"
+    end
+
+    it "returns nil if no post is found" do
+      respond_with(nil, {
+        :uri      => %r|api/v1/posts|,
+        :body     => { error: "Not Found" },
+        :status   => 404
+      })
+
+      post = AudioVision::Post.find_by_url("http://audiovision.scpr.org/posts/104")
+      post.should eq nil
+    end
+  end
+
+
+  describe "initialization" do
+    it 'is a Post' do
+      post = AudioVision::Post.new({
+        "id"              => "post-104",
+        "published_at"    => Time.now.to_s
+      })
+
+      post.id.should eq "post-104"
+      post.assets.should eq Array.new
+      post.attributions.should be_a Array
+    end
+  end
+end

data/spec/lib/audio_vision_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe AudioVision do
+  describe '::api_root' do
+    it 'is the API root' do
+      AudioVision.api_root.should eq "/api/v1"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+Bundler.require
+
+SPEC_ROOT    = File.dirname(__FILE__)
+FIXTURE_ROOT = File.join SPEC_ROOT, "fixtures"
+
+# Require the support files
+Dir["#{SPEC_ROOT}/support/**/*.rb"].each { |f| require f }
+
+# Disallow real network connections
+require 'webmock/rspec'
+WebMock.disable_net_connect!
+
+
+# Configuration
+RSpec.configure do |config|
+  config.include FakeResponse
+
+  config.before do
+    WebMock.reset!
+  end
+end

data/spec/support/fake_response.rb

@@ -0,0 +1,53 @@
+##
+# FakeResponse
+#
+# Helpers for faking responses from the API
+#
+module FakeResponse
+  DEFAULT_CONTENT_TYPE = "application/json"
+  DEFAULT_URI          = %r{#{AudioVision::URL}}
+
+  #---------------------
+  # Takes the filename to respond with,
+  # and (optionally) any options to be passed to 
+  # +FakeWeb.register_uri+.
+  #
+  # If no block is given, the registry will not be cleaned
+  # by this method.
+  #
+  # If passed a block, it will clean the registry after
+  # the block has been run.
+  #
+  def mock_response(filename, options={}, &block)
+    respond_with(filename, options)
+
+    response = yield
+    WebMock.reset!
+
+    response
+  end
+
+  #---------------------
+  # Register the root with WebMock, and set its 
+  # response body to the contents of the requested file.
+  def respond_with(filename, options={})
+    content_type = options[:content_type] || DEFAULT_CONTENT_TYPE
+    uri          = options.delete(:uri) || DEFAULT_URI
+
+    stub_request(:get, uri).to_return(
+      {
+        :body         => load_fixture(filename),
+        :content_type => content_type
+      }.merge(options)
+    )
+  end
+
+  #---------------------
+  # Read a fixure file
+  def load_fixture(filename)
+    return if !filename || filename.empty?
+
+    file = filename == :random ? random_filename : filename
+    File.read(File.join FIXTURE_ROOT, file)
+  end
+end # FakeResponse

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: audio_vision
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Bryan Ricker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for the AudioVision API.
+email:
+- bricker@kpcc.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- audio_vision.gemspec
+- lib/audio_vision.rb
+- lib/audio_vision/asset.rb
+- lib/audio_vision/attribution.rb
+- lib/audio_vision/base.rb
+- lib/audio_vision/billboard.rb
+- lib/audio_vision/bucket.rb
+- lib/audio_vision/category.rb
+- lib/audio_vision/client.rb
+- lib/audio_vision/post.rb
+- lib/audio_vision/version.rb
+- spec/fixtures/billboard1_updated_v1.json
+- spec/fixtures/billboard1_v1.json
+- spec/fixtures/billboards_v1.json
+- spec/fixtures/bucket_v1.json
+- spec/fixtures/buckets_v1.json
+- spec/fixtures/post_v1.json
+- spec/fixtures/posts_images_v1.json
+- spec/fixtures/posts_v1.json
+- spec/lib/audio_vision/asset_spec.rb
+- spec/lib/audio_vision/attribution_spec.rb
+- spec/lib/audio_vision/billboard_spec.rb
+- spec/lib/audio_vision/bucket_spec.rb
+- spec/lib/audio_vision/category_spec.rb
+- spec/lib/audio_vision/client_spec.rb
+- spec/lib/audio_vision/post_spec.rb
+- spec/lib/audio_vision_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_response.rb
+homepage: https://github.com/SCPR/audio_vision-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for the AudioVision API.
+test_files:
+- spec/fixtures/billboard1_updated_v1.json
+- spec/fixtures/billboard1_v1.json
+- spec/fixtures/billboards_v1.json
+- spec/fixtures/bucket_v1.json
+- spec/fixtures/buckets_v1.json
+- spec/fixtures/post_v1.json
+- spec/fixtures/posts_images_v1.json
+- spec/fixtures/posts_v1.json
+- spec/lib/audio_vision/asset_spec.rb
+- spec/lib/audio_vision/attribution_spec.rb
+- spec/lib/audio_vision/billboard_spec.rb
+- spec/lib/audio_vision/bucket_spec.rb
+- spec/lib/audio_vision/category_spec.rb
+- spec/lib/audio_vision/client_spec.rb
+- spec/lib/audio_vision/post_spec.rb
+- spec/lib/audio_vision_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_response.rb
+has_rdoc: