lc_api 0.2

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 LifeChurch.tv
+
+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,133 @@
+# The Lifechurch.tv API Ruby Gem
+
+A Ruby wrapper for the Lifechurch.tv REST API
+
+## Installation
+```ruby
+gem install lc_api
+```
+
+## Quick Start Guide
+First, register your application with LifeChurch.tv at http://api.lifechurch.tv.
+
+Then, copy and paste in your API Key.
+
+```ruby
+LcApi.key = "K690FKW924CKUCJTH94WK294WK029834SDFJ9862KSDF9234SDKF9421KDVDS"
+```
+
+Try finding a single resource:
+
+```ruby
+msg = LcApi::Message.find(1)
+```
+
+Try finding multiple resources:
+
+```ruby
+msg = LcApi::Message.find(:all)
+```
+
+Filter results:
+
+```ruby
+msg = LcApi::Message.find(1, :include => [:series, :speaker], :params => {quantity: 20, page: 2})
+```
+
+Access properties from the results:
+```ruby
+msg.title
+msg.part
+msg.length
+msg.date_released
+```
+
+That's it, you're ready to rock!
+
+## Configuration
+You can configure both the API key and the base URI:
+
+```ruby
+LcApi.key = "K690FKW924CKUCJTH94WK294WK029834SDFJ9862KSDF9234SDKF9421KDVDS"
+LcApi::Base.site = "http://0.0.0.0:3000/v1/"
+```
+
+## Usage Examples
+All examples require an authenticated LifeChurch.tv consumer. See the <a href="#quick-start-guide">quick start</a> section above. 
+
+**Get a message**
+
+```ruby
+LcApi::Message.find(1)
+```
+
+**Get all messages**
+
+```ruby
+LcApi::Message.find(:all)
+```
+
+**Get a message and include series and speakers**
+
+```ruby
+LcApi::Message.find(1, :include => [:series, :speaker])
+```
+
+**Get a message with include and quantity**
+
+```ruby
+LcApi::Message.find(1, :include => [:series, :speaker], :params => {quantity: 5})
+```
+
+**Get all messages with include, quantity, and page**
+```ruby
+LcApi::Message.all(:include => [:series, :speaker], :params => {quantity: 5, page: 2})
+```
+
+**Access properties on a message**
+```ruby
+msg.title
+msg.part
+msg.length
+msg.date_released
+```
+
+**Access properties on a set of messages**
+```ruby
+msg = LcApi::Message.all
+msg.each do |m|
+  msg.title
+  msg.part
+end
+```
+
+## Resources
+
+* LcApi::Location
+* LcApi::Message
+* LcApi::Series
+
+## Filters
+
+***Include***
+
+  :include => [speaker,series]
+
+***Quantity*** (for Message and Series only)
+
+  :quantity => 5
+
+***Page*** (for Message and Series only)
+
+  :page => 2
+
+## Coming Soon
+* Link to API homepage
+* Documentation Like to API
+* More details on optional params (:includes, :quantity, etc.)
+
+## Copyright
+Copyright (c) 2014 LifeChurch.tv.
+See [LICENSE][] for details.
+
+[license]: LICENSE.txt

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lc_api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lc_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lc_api'
+  spec.version       = LcApi::VERSION
+  spec.authors       = ["Scott Lesser"]
+  spec.email         = ["interactive@lifechurch.tv"]
+  spec.summary       = 'LC API'
+  spec.description   = 'A gem for consuming the LifeChurch.tv API - api.lifechurch.tv'
+  spec.homepage      = "http://api.lifechurch.tv"  
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # Runtime Dependencies
+  spec.add_runtime_dependency('activeresource', '>= 3.0.0')
+
+  # Development Dependencies
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fakeweb", ["~> 1.3"]
+end

data/lib/lc_api/base.rb

@@ -0,0 +1,23 @@
+module LcApi
+  class Base < ActiveResource::Base
+    self.site = "http://lctv-api.herokuapp.com/v1"
+
+    class << self
+      attr_accessor :api_key
+    end
+
+    def self.find(*args)
+      scope   = args.slice!(0)
+      options = args.slice!(0) || {}
+
+      if options.has_key? :include
+        options[:params] = (options[:params] || {}).merge({include: options[:include].join(",")})
+      end
+
+
+      options[:params] = (options[:params] || {}).merge({key: LcApi.key})
+
+      super(scope, options)
+    end
+  end
+end

data/lib/lc_api/location.rb

@@ -0,0 +1,4 @@
+module LcApi
+  class Location < Base
+  end
+end

data/lib/lc_api/message.rb

@@ -0,0 +1,4 @@
+module LcApi
+  class Message < Base
+  end
+end

data/lib/lc_api/series.rb

@@ -0,0 +1,4 @@
+module LcApi
+  class Series < Base
+  end
+end

data/lib/lc_api/version.rb

@@ -0,0 +1,3 @@
+module LcApi
+  VERSION = "0.2"
+end

data/lib/lc_api.rb

@@ -0,0 +1,11 @@
+require 'active_resource'
+require 'lc_api/base'
+require 'lc_api/message'
+require 'lc_api/series'
+require 'lc_api/location'
+
+module LcApi
+  class << self 
+    attr_accessor :key
+  end
+end

data/spec/lc_api_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe LcApi do
+  it "should set the key" do
+    LcApi.key = "1111"
+    expect(LcApi.key).to eq "1111"
+  end  
+
+  it "should set the site" do
+    expect(LcApi::Base.site.to_s).to eq SITE_URL
+  end
+end

data/spec/resources/location_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe LcApi::Location do
+  describe "returning all locations" do
+    it "should grab a collection of locations" do
+      FakeWeb.register_uri(:get, "#{SITE_URL}/locations.json?key=1111", :body => [{id: 1}].to_json)
+      @locations = LcApi::Location.find(:all)
+      expect(@locations.class).to eq ActiveResource::Collection
+    end
+  end
+
+  describe "returning a single location" do
+    it "should return a location" do
+      FakeWeb.register_uri(:get, "#{SITE_URL}/locations/2.json?key=1111", :body => {id: 1, foo: "bar"}.to_json)
+      @location = LcApi::Location.find(2)
+      expect(@location.class).to eq LcApi::Location
+    end
+  end
+
+  describe "including the staff info" do
+    it "should include 'staff' in the url" do
+      # If this test passes, that means the url below was correctly called, no need for any expects
+      FakeWeb.register_uri(:get, "#{SITE_URL}/locations/2.json?include=staff&key=1111", :body => {id: 1, foo: "bar"}.to_json)
+      LcApi::Location.find(2, include: [:staff])
+    end
+  end
+
+  describe "including the events info" do
+    it "should include 'events' in the url" do
+      # If this test passes, that means the url below was correctly called, no need for any expects
+      FakeWeb.register_uri(:get, "#{SITE_URL}/locations/2.json?include=events&key=1111", :body => {id: 1, foo: "bar"}.to_json)
+      LcApi::Location.find(2, include: [:events])
+    end
+  end
+end

data/spec/resources/message_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe LcApi::Message do
+  describe "returning all messages" do
+    it "should grab a collection of messages" do
+      FakeWeb.register_uri(:get, "#{SITE_URL}/messages.json?key=1111", :body => [{id: 1}].to_json)
+      @messages = LcApi::Message.find(:all)
+      expect(@messages.class).to eq ActiveResource::Collection
+    end
+  end
+
+  describe "returning a single message" do
+    it "should return a message" do
+      FakeWeb.register_uri(:get, "#{SITE_URL}/messages/2.json?key=1111", :body => {id: 1, foo: "bar"}.to_json)
+      @message = LcApi::Message.find(2)
+      expect(@message.class).to eq LcApi::Message
+    end
+  end
+
+  describe "including the series info" do
+    it "should include 'series' in the url" do
+      # If this test passes, that means the url below was correctly called, no need for any expects
+      FakeWeb.register_uri(:get, "#{SITE_URL}/messages/2.json?include=series&key=1111", :body => {id: 1, foo: "bar"}.to_json)
+      LcApi::Message.find(2, include: [:series])
+    end
+  end
+
+  describe "including the speaker info" do
+    it "should include 'speaker' in the url" do
+      # If this test passes, that means the url below was correctly called, no need for any expects
+      FakeWeb.register_uri(:get, "#{SITE_URL}/messages/2.json?include=speaker&key=1111", :body => {id: 1, foo: "bar"}.to_json)
+      LcApi::Message.find(2, include: [:speaker])
+    end
+  end
+end

data/spec/resources/series_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe LcApi::Series do
+  describe "returning all series" do
+    it "should grab a collection of series" do
+      FakeWeb.register_uri(:get, "#{SITE_URL}/series.json?key=1111", :body => [{id: 1}].to_json)
+      @series = LcApi::Series.find(:all)
+      expect(@series.class).to eq ActiveResource::Collection
+    end
+  end
+
+  describe "returning a single series" do
+    it "should return a series" do
+      FakeWeb.register_uri(:get, "#{SITE_URL}/series/2.json?key=1111", :body => {id: 1, foo: "bar"}.to_json)
+      @series = LcApi::Series.find(2)
+      expect(@series.class).to eq LcApi::Series
+    end
+  end
+
+  describe "including the messages info" do
+    it "should include 'messages' in the url" do
+      # If this test passes, that means the url below was correctly called, no need for any expects
+      FakeWeb.register_uri(:get, "#{SITE_URL}/series/2.json?include=messages&key=1111", :body => {id: 1, foo: "bar"}.to_json)
+      LcApi::Series.find(2, include: [:messages])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'lc_api'
+require 'fakeweb'
+FakeWeb.allow_net_connect = false
+LcApi.key = "1111"
+SITE_URL = "http://lctv-api.herokuapp.com/v1"

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: lc_api
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
+platform: ruby
+authors:
+- Scott Lesser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: A gem for consuming the LifeChurch.tv API - api.lifechurch.tv
+email:
+- interactive@lifechurch.tv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lc_api.gemspec
+- lib/lc_api.rb
+- lib/lc_api/base.rb
+- lib/lc_api/location.rb
+- lib/lc_api/message.rb
+- lib/lc_api/series.rb
+- lib/lc_api/version.rb
+- spec/lc_api_spec.rb
+- spec/resources/location_spec.rb
+- spec/resources/message_spec.rb
+- spec/resources/series_spec.rb
+- spec/spec_helper.rb
+homepage: http://api.lifechurch.tv
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: LC API
+test_files:
+- spec/lc_api_spec.rb
+- spec/resources/location_spec.rb
+- spec/resources/message_spec.rb
+- spec/resources/series_spec.rb
+- spec/spec_helper.rb