greengoose 0.0.1.pre1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,22 @@
+# GreenGoose
+
+Ruby wrapper for the [GreenGoose](http://www.greengoose.com) [API](http://apiwiki.greengoose.com/index.php/REST_API).
+
+**WIP:** This gem is still a work in progress. It's not fully functional
+yet.
+
+## Quick Start
+
+If using Bundler (recommended), add to Gemfile:
+
+```ruby
+gem 'greengoose'
+```
+
+Create a client object and authenticate with a username and password
+([signup](http://www.greengoose.com/signup))
+
+```ruby
+client = Greengoose::Client.new
+client.authenticate "username", "password"
+```

data/Rakefile

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

data/greengoose.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "greengoose/version"
+
+Gem::Specification.new do |s|
+  s.name        = "greengoose"
+  s.version     = GreenGoose::VERSION
+  s.authors     = ["Andy Lindeman"]
+  s.email       = ["alindeman@gmail.com"]
+  s.homepage    = "https://github.com/alindeman/greengoose"
+  s.summary     = %q{Provides a Ruby interface to the GreenGoose REST API}
+  s.description = %q{The GreenGoose API enables developers to build fun applications that interact with the GreenGoose real-world sensor platform
+  }
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~>2.7.0"
+  s.add_development_dependency "mocha", "~>0.10.0"
+  s.add_development_dependency "webmock", "~>1.7.8"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "rake"
+
+  s.add_runtime_dependency "faraday", "~>0.7"
+  s.add_runtime_dependency "multi_json", "~>1.0"
+end

data/lib/greengoose.rb

@@ -0,0 +1,8 @@
+require "faraday"
+require "multi_json"
+
+require File.expand_path("greengoose/version", File.dirname(__FILE__))
+
+require File.expand_path("greengoose/client", File.dirname(__FILE__))
+require File.expand_path("greengoose/credentials", File.dirname(__FILE__))
+require File.expand_path("greengoose/middleware", File.dirname(__FILE__))

data/lib/greengoose/client.rb

@@ -0,0 +1,47 @@
+module GreenGoose
+  # Green Goose API client
+  class Client
+    extend Forwardable
+
+    # Defines get, post, etc...
+    def_delegators :connection, *Faraday::Connection::METHODS
+
+    attr_reader :credentials
+
+    API_URL     = "http://api.greengoose.com"
+    API_VERSION = 1
+
+    # Creates a new API client
+    def initialize
+    end
+
+    # Authenticates against the API using a username and password
+    #
+    # @param [String] username API Username
+    # @param [String] password API Password
+    def authenticate(username, password)
+      @credentials = Credentials::Basic.new(username, password)
+      @credentials.configure_connection(connection)
+
+      self
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new api_url,
+                      :headers => { "User-Agent" => user_agent } do |builder|
+        builder.use Middleware::JSON
+        builder.adapter ::Faraday.default_adapter
+      end
+    end
+
+    def api_url
+      "#{API_URL}/v#{API_VERSION}"
+    end
+
+    def user_agent
+      "Ruby:GreenGoose:#{VERSION}"
+    end
+  end
+end

data/lib/greengoose/credentials.rb

@@ -0,0 +1 @@
+require File.expand_path("credentials/basic", File.dirname(__FILE__))

data/lib/greengoose/credentials/basic.rb

@@ -0,0 +1,16 @@
+module GreenGoose
+  module Credentials
+    class Basic
+      attr_reader :username, :password
+
+      def initialize(username, password)
+        @username = username
+        @password = password
+      end
+
+      def configure_connection(connection)
+        connection.basic_auth(username, password)
+      end
+    end
+  end
+end

data/lib/greengoose/middleware.rb

@@ -0,0 +1 @@
+require File.expand_path("middleware/json", File.dirname(__FILE__))

data/lib/greengoose/middleware/json.rb

@@ -0,0 +1,32 @@
+module GreenGoose
+  module Middleware
+    class JSON < ::Faraday::Request::UrlEncoded
+      self.mime_type = "application/json".freeze
+
+      dependency 'multi_json'
+
+      def call(env)
+        match_content_type(env) do |data|
+          env[:body] = ::MultiJson.encode(data)
+        end
+
+        @app.call(env).on_complete do
+          env[:body] = parse(env[:body])
+        end
+      end
+
+      def parse(body)
+        case body
+        when ''
+          nil
+        when 'true'
+          true
+        when 'false'
+          false
+        else
+          ::MultiJson.decode(body)
+        end
+      end
+    end
+  end
+end

data/lib/greengoose/version.rb

@@ -0,0 +1,3 @@
+module GreenGoose
+  VERSION = "0.0.1.pre1"
+end

data/spec/greengoose/client_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe GreenGoose::Client do
+  it "sets the User Agent as requested by GreenGoose" do
+    # http://apiwiki.greengoose.com/index.php/User_Agents
+    req = stub_request(:get, "http://api.greengoose.com").with do |req|
+      req.headers["User-Agent"] =~ /Ruby:GreenGoose:#{GreenGoose::VERSION}/
+    end
+
+    res = subject.get '/'
+  end
+
+  describe "authentication" do
+    context "username and password" do
+      before { subject.authenticate("andy", "1234") }
+
+      it "authenticates against the API with the provided credentials" do
+        req = stub_request(:get, "http://andy:1234@api.greengoose.com/")
+
+        res = subject.get '/'
+        req.should have_been_requested
+      end
+    end
+  end
+end

data/spec/greengoose/credentials/basic_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe GreenGoose::Credentials::Basic do
+  it "accepts and stores a username and password" do
+    credentials = described_class.new("andy", "1234")
+
+    credentials.username.should == "andy"
+    credentials.password.should == "1234"
+  end
+
+  describe "#configure_connection" do
+    it "configures the Faraday connection to use the credentials" do
+      connection = stub
+      connection.expects(:basic_auth).with("andy", "1234")
+
+      credentials = described_class.new("andy", "1234")
+      credentials.configure_connection(connection)
+    end
+  end
+end

data/spec/greengoose/middleware/json_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe GreenGoose::Middleware::JSON do
+  let(:connection) {
+    Faraday.new("http://api.greengoose.com") do |builder|
+      builder.use described_class
+      builder.adapter Faraday.default_adapter
+    end
+  }
+
+  describe "request" do
+    it "sends the content type as application/json" do
+      req = stub_request(:post, "api.greengoose.com").with do |req|
+        req.headers["Content-Type"] == "application/json"
+      end
+
+      res = connection.post "/" do |req|
+        req.body = { }
+      end
+
+      req.should have_been_requested
+    end
+
+    it "sends the request body encoded as JSON" do
+      req = stub_request(:post, "api.greengoose.com").
+              with(:body => "{\"foo\":\"bar\"}")
+
+      res = connection.post "/" do |req|
+        req.body = { :foo => "bar" }
+      end
+
+      req.should have_been_requested
+    end
+  end
+
+  describe "response" do
+    it "parses the body as JSON" do
+      req = stub_request(:get, "api.greengoose.com").
+              to_return(:body => "{\"foo\":\"bar\"}")
+
+      res = connection.get "/"
+      res.body.should == { "foo" => "bar" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require File.expand_path("../lib/greengoose", File.dirname(__FILE__))
+
+require "mocha"
+require "webmock/rspec"
+require "pry"
+
+RSpec.configure do |c|
+  c.mock_with :mocha
+
+  c.before(:each) do
+    WebMock.enable!
+    WebMock.disable_net_connect!
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: greengoose
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre1
+  prerelease: 6
+platform: ruby
+authors:
+- Andy Lindeman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70322071249240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70322071249240
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70322071208960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70322071208960
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70322071208400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+  type: :development
+  prerelease: false
+  version_requirements: *70322071208400
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70322071207600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70322071207600
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70322071206760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70322071206760
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70322071205600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70322071205600
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70322071204560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70322071204560
+description: ! "The GreenGoose API enables developers to build fun applications that
+  interact with the GreenGoose real-world sensor platform\n  "
+email:
+- alindeman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- greengoose.gemspec
+- lib/greengoose.rb
+- lib/greengoose/client.rb
+- lib/greengoose/credentials.rb
+- lib/greengoose/credentials/basic.rb
+- lib/greengoose/middleware.rb
+- lib/greengoose/middleware/json.rb
+- lib/greengoose/version.rb
+- spec/greengoose/client_spec.rb
+- spec/greengoose/credentials/basic_spec.rb
+- spec/greengoose/middleware/json_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alindeman/greengoose
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1129379011405296523
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Provides a Ruby interface to the GreenGoose REST API
+test_files:
+- spec/greengoose/client_spec.rb
+- spec/greengoose/credentials/basic_spec.rb
+- spec/greengoose/middleware/json_spec.rb
+- spec/spec_helper.rb