thingspeak-api 0.1.pre

data/README.md

@@ -0,0 +1,54 @@
+ThingSpeak API
+==============
+
+This is a Ruby wrapper for interacting with the ThingSpeak (http://www.thingspeak.com) REST API from Ruby programs.
+API docs for ThingSpeak can be found at http://community.thingspeak.com/documentation/api/
+
+**NOTE: This gem is still prerelease and under development.**
+
+To use, simply include it in your Gemfile:
+
+    gem 'thingspeak-api'
+
+or install from the command line:
+
+    gem install 'thingspeak-api'
+
+Create a client with your read key and write key and send a message to your channel:
+
+```ruby
+require 'thingspeak'
+
+client = ThingSpeak::Client.new("YOUR_WRITE_KEY", "YOUR_READ_KEY")
+
+# post an update to your channel, returns the identifier of the new post if successful
+client.update_channel({field1: "foo", field2: "bar"}) # => 3
+
+```
+
+
+License
+-------
+
+MIT License
+
+Copyright (c) 2012 Daniel Treacy
+
+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/lib/thingspeak.rb

@@ -0,0 +1,6 @@
+require 'thingspeak/version'
+require 'thingspeak/paths'
+require 'thingspeak/exceptions'
+require 'thingspeak/request'
+require 'thingspeak/update'
+require 'thingspeak/client'

data/lib/thingspeak/client.rb

@@ -0,0 +1,22 @@
+require 'rest_client'
+
+module ThingSpeak
+  class Client
+    def initialize(write_key, read_key)
+      @write_key = write_key
+      @read_key = read_key
+
+      self
+    end
+
+    def update_channel(hash)
+      update = ThingSpeak::Update.new(hash)
+
+      begin
+        RestClient.post ThingSpeak::THINGSPEAK_UPDATE_URL, update.build_params.with_key(@write_key)
+      rescue
+        puts "RestClient error"
+      end
+    end
+  end
+end

data/lib/thingspeak/exceptions.rb

@@ -0,0 +1,5 @@
+module ThingSpeak
+  module Exceptions
+
+  end
+end

data/lib/thingspeak/paths.rb

@@ -0,0 +1,6 @@
+module ThingSpeak
+
+  THINGSPEAK_BASE_URL = "http://api.thingspeak.com"
+  THINGSPEAK_UPDATE_URL = "#{THINGSPEAK_BASE_URL}/update"
+
+end

data/lib/thingspeak/request.rb

@@ -0,0 +1,25 @@
+module ThingSpeak
+  class Request
+    def build_params
+      params = {}
+
+      self.params.each do |k, v|
+        params[k] = v
+      end
+
+      params[:lat] = self.lat if self.lat
+      params[:long] = self.long if self.long
+      params[:elevation] = self.elevation if self.elevation
+      params[:status] = self.status if self.status
+      params[:twitter] = self.twitter if self.twitter
+      params[:tweet] = self.tweet if self.tweet
+
+      params.class.send(:define_method, :with_key) do |key|
+        self[:key] = key
+        self
+      end
+
+      params
+    end
+  end
+end

data/lib/thingspeak/update.rb

@@ -0,0 +1,21 @@
+module ThingSpeak
+
+  class Update < Request
+    attr_accessor :params, :lat, :long, :elevation, :status, :twitter, :tweet
+
+    def initialize(params, location = {}, status = nil, twitter = nil, tweet = nil)
+      raise ArgumentError.new("First argument to Update#new should be a Hash.") unless params.instance_of?(Hash)
+
+      self.params = params
+      self.lat = location[:lat]
+      self.long = location[:long]
+      self.elevation = location[:elevation]
+      self.status = status
+      self.twitter = twitter
+      self.tweet = tweet
+
+      self
+    end
+  end
+
+end

data/lib/thingspeak/version.rb

@@ -0,0 +1,5 @@
+module ThingSpeak
+
+  VERSION = "0.1.pre" unless defined?(::ThingSpeak::VERSION)
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: thingspeak-api
+version: !ruby/object:Gem::Version
+  version: 0.1.pre
+  prerelease: 4
+platform: ruby
+authors:
+- Daniel Treacy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70199655853840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70199655853840
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70199655853400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70199655853400
+description: A wrapper for the ThingSpeak API to make interacting with your ThingSpeak
+  channels easy from Ruby-based applications
+email: daniel.t.treacy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/thingspeak/client.rb
+- lib/thingspeak/exceptions.rb
+- lib/thingspeak/paths.rb
+- lib/thingspeak/request.rb
+- lib/thingspeak/update.rb
+- lib/thingspeak/version.rb
+- lib/thingspeak.rb
+- README.md
+homepage: http://github.com/danieltreacy/thingspeak-api
+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'
+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.17
+signing_key: 
+specification_version: 3
+summary: Ruby DSL for interacting with ThingSpeak API
+test_files: []