audio_vision 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65f96343d62472eca34e5f679543b6d94740a9d3
+  data.tar.gz: 83781ab608c3594fbe0afa38aecfd459bf254398
+SHA512:
+  metadata.gz: 53745f097f82206eed4675ff9e4c33be0dde68321cf13bba4a6ade2e110861789cfeb735db3a9e03739c4e30ce56e967c8a469d823f9d31e2e7e9ff9c63489d8
+  data.tar.gz: 76d9377bcaa27b448ad7d9b557823c13deaf43b403bd33877a9ba2b0b9016ae2484911cf76d4a558fd1d77633688b72be1301b83cc59e5871772ab11b47393af

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0.rc1
+First release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in audiovision-ruby.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bryan Ricker
+
+MIT License
+
+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,52 @@
+# AudioVision
+
+This is a simple Ruby client for the AudioVision API.
+Documentation for the AudioVision API can be found
+[**here**](https://github.com/SCPR/api-docs/tree/master/AudioVision/v1).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'audio_vision'
+
+
+## Usage
+
+### Posts
+```ruby
+# Find by ID
+AudioVision::Post.find(109)
+
+# Find by URL
+AudioVision::Post.find_by_url("http://audiovision.scpr.org/319/public-square-thankful-for")
+
+# Find Collection - all parameters are passed directly to API
+AudioVision::Post.collection(limit: 10, query: "Los Angeles", category: "video")
+```
+
+### Billboards
+```ruby
+# Find by ID
+AudioVision::Billboard.find(4)
+
+# Get the current Billboard
+AudioVision::Billboard.current
+
+# Get all Billboards
+AudioVision::Billboard.collection
+```
+
+### Buckets
+```ruby
+# Find by UUID (key)
+AudioVision::Billboard.find("featured-posts")
+
+# Get all Buckets
+AudioVision::Bucket.collection
+```
+
+
+## Contributing
+Fork it, fix it, send a PR. `bundle exec rspec` to run tests.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/audio_vision.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'audio_vision/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "audio_vision"
+  spec.version       = AudioVision::VERSION
+  spec.authors       = ["Bryan Ricker"]
+  spec.email         = ["bricker@kpcc.org"]
+  spec.description   = %q{Ruby client for the AudioVision API.}
+  spec.summary       = %q{Ruby client for the AudioVision API.}
+  spec.homepage      = "https://github.com/SCPR/audio_vision-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.8.8"
+  spec.add_dependency "faraday_middleware", "~> 0.9.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/lib/audio_vision.rb

@@ -0,0 +1,22 @@
+module AudioVision
+  URL           = "http://audiovision.scpr.org"
+  API_ROOT      = "/api"
+  API_VERSION   = "v1"
+
+  class << self
+    # The API root path for all requests.
+    def api_root
+      @api_root ||= [API_ROOT, API_VERSION].join("/")
+    end
+  end
+end
+
+require 'audio_vision/version'
+require 'audio_vision/client'
+require 'audio_vision/attribution'
+require 'audio_vision/category'
+require 'audio_vision/asset'
+require 'audio_vision/base'
+require 'audio_vision/billboard'
+require 'audio_vision/bucket'
+require 'audio_vision/post'

data/lib/audio_vision/asset.rb

@@ -0,0 +1,40 @@
+module AudioVision
+  class Asset
+
+    class Size
+      attr_accessor :width, :height, :url
+
+      def initialize(attributes={})
+        @width    = attributes['width']
+        @height   = attributes['height']
+        @url      = attributes['url']
+      end
+    end
+
+
+    ATTRIBUTES = [
+      :caption,
+      :owner,
+      :title
+    ]
+
+    SIZES = [
+      :thumbnail,
+      :small,
+      :large,
+      :full
+    ]
+
+    attr_accessor *(ATTRIBUTES + SIZES)
+
+    def initialize(attributes={})
+      @caption  = attributes["caption"]
+      @owner    = attributes["owner"]
+      @title    = attributes["title"]
+
+      SIZES.each do |size|
+        self.send("#{size}=", Asset::Size.new(attributes[size.to_s]))
+      end
+    end
+  end
+end

data/lib/audio_vision/attribution.rb

@@ -0,0 +1,18 @@
+module AudioVision
+  class Attribution
+
+    attr_accessor \
+      :name,
+      :url,
+      :role_text,
+      :role
+
+
+    def initialize(attributes={})
+      @name       = attributes["name"]
+      @url        = attributes["url"]
+      @role_text  = attributes["role_text"]
+      @role       = attributes["role"]
+    end
+  end
+end

data/lib/audio_vision/base.rb

@@ -0,0 +1,78 @@
+require 'time'
+
+module AudioVision
+  # This is a private class and shouldn't be used directly.
+  # It acts as a base class for all of the AudioVision classes which
+  # are available in the API.
+  class Base
+
+    class << self
+      # Returns the API path for this class.
+      # Example: /api/v1/posts
+      def api_path
+        @api_path ||= [AudioVision.api_root, self.api_namespace].join("/")
+      end
+
+      # Find an object by its ID.
+      # Returns the object if found, otherwise false.
+      #
+      # Example:
+      #    AudioVision::Post.find(10) #=> #<AudioVision::Post>
+      def find(id)
+        response = client.get(endpoint(id))
+
+        if response.success?
+          new(response.body)
+        else
+          false
+        end
+      end
+
+
+      # Get a collection of posts.
+      # Passed-in parameters are passed directly to the API.
+      # Returns an array of Posts.
+      #
+      # Example:
+      #   AudionVision::Post.collection(limit: 5, query: "Photos") #=> [ ... ]
+      def collection(options={})
+        response = client.get(api_path, options)
+
+        if response.success?
+          collection = []
+
+          response.body.each do |json|
+            collection << new(json)
+          end
+
+          collection
+        else
+          []
+        end
+      end
+
+
+      private
+
+      def endpoint(*segments)
+        [self.api_namespace, *segments].join("/")
+      end
+
+      def client
+        @client ||= AudioVision::Client.new
+      end
+    end
+
+
+    # Steal the ActiveRecord behavior for object comparison.
+    # If they're the same class and the ID is the same, then it's "same"
+    # enough for us.
+    def ==(comparison_object)
+      super ||
+        comparison_object.instance_of?(self.class) &&
+        self.id && self.id == comparison_object.id
+    end
+    alias :eql? :==
+
+  end
+end

data/lib/audio_vision/billboard.rb

@@ -0,0 +1,54 @@
+module AudioVision
+  class Billboard < Base
+
+    class << self
+      def api_namespace
+        :billboards
+      end
+
+
+      # Get the current Billboard on AudioVision.
+      # Returns a Billboard if success, otherwise nil.
+      #
+      # Example:
+      #    AudioVision::Billboard.current #=> #<AudioVision::Billboard>
+      def current
+        response = client.get(endpoint("current"))
+
+        if response.success?
+          new(response.body)
+        else
+          nil
+        end
+      end
+    end
+
+
+    attr_accessor \
+      :id,
+      :layout,
+      :published_at,
+      :updated_at,
+      :posts
+
+
+    def initialize(attributes={})
+      @id       = attributes["id"]
+      @layout   = attributes["layout"]
+
+      if attributes["published_at"]
+        @published_at = Time.parse(attributes["published_at"].to_s)
+      end
+
+      if attributes["updated_at"]
+        @updated_at = Time.parse(attributes["updated_at"].to_s)
+      end
+
+      @posts = []
+
+      Array(attributes["posts"]).each do |json|
+        @posts << AudioVision::Post.new(json)
+      end
+    end
+  end
+end

data/lib/audio_vision/bucket.rb

@@ -0,0 +1,37 @@
+module AudioVision
+  class Bucket < Base
+
+    class << self
+      def api_namespace
+        :buckets
+      end
+
+      alias :find_by_key :find
+    end
+
+
+    attr_accessor \
+      :id,
+      :title,
+      :description,
+      :updated_at,
+      :posts
+
+
+    def initialize(attributes={})
+      @id           = attributes["id"]
+      @title        = attributes["title"]
+      @description  = attributes["description"]
+
+      if attributes["updated_at"]
+        @updated_at = Time.parse(attributes["updated_at"].to_s)
+      end
+
+      @posts = []
+
+      Array(attributes["posts"]).each do |json|
+        @posts << AudioVision::Post.new(json)
+      end
+    end
+  end
+end

data/lib/audio_vision/category.rb

@@ -0,0 +1,20 @@
+module AudioVision
+  class Category
+
+    attr_accessor \
+      :id,
+      :title,
+      :slug,
+      :description,
+      :public_url
+
+
+    def initialize(attributes={})
+      @id           = attributes["id"]
+      @title        = attributes["title"]
+      @slug         = attributes["slug"]
+      @description  = attributes["description"]
+      @public_url   = attributes["public_url"]
+    end
+  end
+end

data/lib/audio_vision/client.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module AudioVision
+  class Client
+    # Get a response from the AudioVision API.
+    # Returns a Faraday Response object.
+    #
+    # Example:
+    #   client.get("posts/1")
+    def get(path, params={})
+      connection.get do |request|
+        request.url path
+        request.params = params
+      end
+    end
+
+
+    private
+
+    def connection
+      @connection ||= begin
+        Faraday.new(:url => api_root) do |conn|
+          conn.response :json
+          conn.adapter Faraday.default_adapter
+        end
+      end
+    end
+
+    def api_root
+      @api_root ||= AudioVision::URL + AudioVision.api_root
+    end
+  end
+end