feed_burner 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a9a43d1e37f01b9a298909a4afe4a9739ef7b9c
+  data.tar.gz: ff2cdabaae991195865bb6e2f06395986aeca6d2
+SHA512:
+  metadata.gz: af43bf60e8c6105b78ee717c9336fea099cad62c7619abedf048da47e34237a59f4913013060da5a64f6fc8eebdf8523976eb2cded6c2b0fa77e5e13e22dd78e
+  data.tar.gz: 15e784f546ee9f1867d89ed2468e9cb05f53cbbfa7b2f7dd5241437071d601885d1abe0b5aaf221afd4b736db6ad7837792d03e138a08d9ddb2678bd8163ff0a

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,12 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'faraday', '~> 0.8.7'
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'rspec', '>= 2.11'
+  gem 'simplecov', :require => false
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Raphael Weiner
+
+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,68 @@
+# FeedBurner
+
+FeedBurner is gem for consuming the FeedEngine API. As defined on the [Feed Engine](http://tutorials.jumpstartlab.com/projects/feed_engine.html) project page, the API should produce JSON output and expect JSON payloads for creation and updating actions.
+
+As an authenticated API user (using an API key) you can:
+
+* Read any publically viewable trip feed via GET, and filter only feed items created directly on FeedEngine (text)
+* Read any private trip feed to which the user has access via GET, and filter only feed items created directly on FeedEngine (text)
+* Publish a text feed item given the appropriate arguments, via POST
+* **(Remove this?)** Refeed another user’s feed item, given its id
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'feed_burner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install feed_burner
+
+### Getting Started
+
+Let's get Feed Burning!
+
+First, you'll need to [create a Feed Engine account](http://kreepr.com/), then navigate to your [account page](http://kreepr.com/account) to retrieve your API key.
+
+Once you have your key, configure the gem by setting your API key as such (in a Rails app, this could be put in config/initializers/feed_burner.rb):
+
+```ruby
+FeedBurner.configure do |config|
+  config.api_key = YOUR_API_KEY
+end
+```
+
+That's it! You're ready to talk to Feed Engine.
+
+### Usage Examples
+
+Retrieve feed items for a specific trip (trip must be public, or you must have permissions to view it):
+
+```ruby
+FeedBurner.feed({:username => <username>, :trip_id => <trip id>})
+```
+
+Retrieve only notes posted from FeedEngine:
+
+```ruby
+FeedBurner.feed({:username => <username>, :trip_id => <trip id>, :only => :text})
+```
+
+Publish a text feed item given the appropriate arguments, via POST
+
+```ruby
+FeedBurner.post_note({:username => <username>, :trip_id => <trip id>, :text => <text>})
+```
+
+### Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/feed_burner.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'feed_burner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "feed_burner"
+  spec.version       = FeedBurner::VERSION
+  spec.authors       = ["Raphael Weiner, Erin Drummond, Kyle Suss, Phil Battos"]
+  spec.email         = ["kreeprmail@gmail.com"]
+  spec.description   = %q{Consume the Feed Engine API}
+  spec.summary       = %q{Feed Burner is a gem to consume the Feed Engine API}
+  spec.homepage      = "http://github.com/raphweiner/feed_burner"
+  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{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/feed_burner/configurable.rb

@@ -0,0 +1,20 @@
+module FeedBurner
+  module Configurable
+    attr_accessor :api_key
+
+    def configure
+      yield self
+      validate_key_type!
+    end
+
+    private
+
+    def validate_key_type!
+      if !api_key.nil?
+        unless api_key.is_a?(String) || api_key.is_a?(Symbol)
+          raise ArgumentError, "Invalid api_key specified: #{api_key} must be a string or symbol."
+        end
+      end
+    end
+  end
+end

data/lib/feed_burner/version.rb

@@ -0,0 +1,3 @@
+module FeedBurner
+  VERSION = "0.0.2"
+end

data/lib/feed_burner.rb

@@ -0,0 +1,41 @@
+require "json"
+require "faraday"
+require "openssl"
+
+require "feed_burner/version"
+require "feed_burner/configurable"
+
+module FeedBurner
+  class << self
+    include Configurable
+
+    def feed(params)
+      validate_params!(params)
+      response = ::Faraday.get(request_uri(params))
+      response.body
+    end
+
+    private
+
+    def validate_params!(params)
+      unless params[:trip_id].is_a?(String) && params[:username].is_a?(String)
+        raise ArgumentError, "Invalid arguments specified: #{params}. Coordinator and Trip are required."
+      end
+    end
+
+    def request_uri(params)
+      uri = "http://localhost:3000/api/v1/feeds/#{params[:trip_id]}?"
+      uri << "username=#{params[:username]}"
+      uri << "&timestamp=#{Time.now.to_i}"
+      uri << "&text_only=#{params[:text_only]}" if params[:text_only]
+
+      signature = encrypted_token(uri)
+
+      uri << "&signature=#{signature}"
+    end
+
+    def encrypted_token(uri)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), api_key.to_s, uri)
+    end
+  end
+end

data/spec/feed_burner_spec.rb

@@ -0,0 +1,84 @@
+require 'feed_burner'
+
+describe FeedBurner do
+  context 'with an api_key of valid type' do
+    it 'should be configurable' do
+      FeedBurner.configure do |config|
+        config.api_key = "abc_123"
+      end
+
+      expect(FeedBurner.api_key).to eq 'abc_123'
+    end
+  end
+
+  context 'with an api_key of invalid type' do
+    it 'should raise an argument error' do
+      expect {
+        FeedBurner.configure do |config|
+          config.api_key = {"abc_123" => :hello}
+        end
+        }.to raise_error ArgumentError
+    end
+  end
+
+  describe '.feed' do
+    let(:params) { {:username => 'ebdrummond', :trip_id => '1', :text_only => true} }
+
+    context 'with invalid input' do
+      it 'should raise an argument error without a username' do
+        params[:username] = nil
+        expect { FeedBurner.feed(params) }.to raise_error ArgumentError
+      end
+
+      it 'should raise an argument error with an invalid username type' do
+        params[:username] = 1234
+        expect { FeedBurner.feed(params) }.to raise_error ArgumentError
+      end
+
+      it 'should raise an argument error without a trip_id' do
+        params[:trip_id] = nil
+        expect { FeedBurner.feed(params) }.to raise_error ArgumentError
+      end
+
+      it 'should raise an argument error with an invalid trip_id type' do
+        params[:trip_id] = 1234
+        expect { FeedBurner.feed(params) }.to raise_error ArgumentError
+      end
+
+      it 'does not raise an error without a :text_only flag' do
+        params.delete(:text_only)
+        expect { FeedBurner.feed(params) }.to_not raise_error ArgumentError
+      end
+    end
+
+    context 'with valid input' do
+      context 'but invalid or missing api_key' do
+        let(:bad_auth_response) do
+          JSON.parse('{ "errors": [ { "message":"Bad Authentication data","code":215 } ] }')
+        end
+
+        it 'receives an bad authentication error' do
+          expect(FeedBurner.feed(params)).to eq bad_auth_response
+        end
+      end
+
+      context 'with a valid api_key' do
+        let(:params) { {:username => 'ebdrummond', :trip_id => '1', :text_only => true} }
+
+        context 'to a public trip' do
+          it 'returns the feed' do
+            {:username => 'ebdrummond', :trip_id => '1', :text_only => true}
+          end
+        end
+
+        context 'to a private trip I have access to' do
+          it 'returns the feed'
+        end
+
+        context 'to a private trip I do not have access to' do
+          it 'raises an error'
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: feed_burner
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Raphael Weiner, Erin Drummond, Kyle Suss, Phil Battos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-21 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Consume the Feed Engine API
+email:
+- kreeprmail@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- feed_burner.gemspec
+- lib/feed_burner.rb
+- lib/feed_burner/configurable.rb
+- lib/feed_burner/version.rb
+- spec/feed_burner_spec.rb
+homepage: http://github.com/raphweiner/feed_burner
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Feed Burner is a gem to consume the Feed Engine API
+test_files:
+- spec/feed_burner_spec.rb