xively-rb 0.2.09

data/.gitignore

@@ -0,0 +1,13 @@
+.DS_Store
+.bundle/*
+*.swp
+*.swo
+Gemfile.lock
+.gem/*
+build_artefacts/*
+coverage/*
+debug.log
+test.sqlite3.db
+*.gem
+*.orig
+vendor/bundle

data/.rbenv-version

@@ -0,0 +1 @@
+ruby-1.9.3-p392

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create 1.8.7-p249@xively-rb

data/.travis.yml

@@ -0,0 +1,7 @@
+bundler_args: --without development
+language: ruby
+env: COVERAGE=on
+script: bundle exec rspec spec
+rvm:
+ - 1.9.2
+ - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,91 @@
+# Changelog
+
+## 0.1.11
+ * Keys always have a root node of 'keys'
+
+## 0.1.10
+ * Adding label field to Keys
+ * should pass options through to Key#as_json
+ * Clearing up some confusion with trigger/key parsers
+ * Improving the Key.to_json error handling
+
+## 0.1.09
+ * Adding Key model for api keys, XML/JSON parsers, and JSON template
+
+## 0.1.08
+ * Rewrote tag string parser
+
+## 0.1.07
+ * Adding some validations on feed_id for datastreams and datapoints
+
+## 0.1.06
+ * Feeds should invalidate with duplicate datastream ids or invalid datastreams
+ * Fixed a bug in Template#method_missing
+
+## 0.1.05
+ * Added CSV feed parsing with autodetection of version
+
+## 0.1.04
+ * Added user node parsers to Feed eeml 0.5.1 and json 1.0.0
+
+## 0.1.03
+ * Added owner_login and owner_user_level to Feed
+ * user node added to json 1.0.0 and eeml 0.5.1 templates for Feed
+
+## 0.1.02
+ * Bug fix release
+ * Handling empty (nil) datastreams in json 1.0.0 (feeds and search results)
+
+## 0.1.01
+ * Major release that 
+ * Eliminates requirement for ActiveSupport / ActiveModel
+ * PachubeDataFormat objects have basic validation
+
+## 0.0.3
+ * Ignore nil tags with json parsers
+ * Added templates for datastream level eeml 005 and 0.5.1
+ * Added templates for EEML 005 and 0.5.1 (v1 / v2)
+ * Eeml 0.5.1 and 5 datastream parser
+ * Eeml 0.5.1 and 5 feed parser
+ * Providing as_pachube_xml on AR records
+ * Adding creator to default xml parsers
+ * encode xml in utf-8
+ * Adding feed_id and feed_creator onto datastream (used by xml)
+ * Creator is always http://www.haque.co.uk in v1 xml
+ * Creator always http://www.haque.co.uk in v1 templates
+ * First pass at a Datapoint model w/ parsers and templates
+ * Added datapoints to json parser
+ * Creating datapoint templates
+ * Templates append format onto feed url
+ * order of xml attributes
+ * Hash#delete_if_nil_value
+ * Completely ignore unit nodes in xml if no unit attributes present
+ * iso8601 shouldn't be to precision of v2 api     ignore nil.iso8601 calls
+ * Allow excluding datastreams
+ * Hooking up datapoints into ActiveRecord
+ * Bug fix: Datapoint json template wasn't formatting time to iso8601(6)
+ * datapoint templates need no version as there is only one
+ * moving private node
+ * Hide min/max value nodes on eeml 0.5.1 templates
+ * Simplifying ActiveRecord hooks     Updated documentation
+ * Datapoint templates should iso8601 at     Feed json template datapoints in iso8601(6)
+ * Added json template for search results
+ * XML and JSON templates for search results
+ * Adding opensearch namespace and nodes
+ * Merge branch 'hotfix-0.0.2' into develop
+ * Incorporating hotfix changes into search results
+ * Restructure of lib
+ * Basic csv for datapoints (full and minimal)
+ * Basic csv for datastreams and feeds      * V1      * V2      * V2 full
+ * Allows options to be passed to to_csv
+ * KICK: Keep it consistent knucklehead
+ * Datastream#to_csv shows datapoints      * options[:both] will include datastream as first element      * Will only show datastream if no datapoints      * Will only show all datapoints if any
+ * Escaping csv cells properly
+ * Handling datapoints in feed#to_csv
+ * Adding depth option to datapoint#to_csv
+ * Adding depth option to datastream#to_csv
+ * Ignoring units in eeml if no attributes present
+ * Refactoring specs
+ * Handle empty tags in xml
+ * Ignore primary nodes in xml feed templates
+

data/CONTRIBUTING.md

@@ -0,0 +1,95 @@
+Whether it's clarifying how to use them, requesting new features, finding bugs, or contributing to writing them yourself, the Xively libraries are completely open-source and always being updated, and we want to hear your thoughts.
+
+Feel free to fork and improve this library any way you want. If you feel that the library benefits from your changes, please open a pull request and contribute back!
+
+
+## Getting Help with Using a Library
+For discussion, questions, and help with implementation, we use [Stack Overflow](http://stackoverflow.com/questions/tagged/xively).  Be sure to use a `xively` tag.
+
+## Requesting New Features
+If you've got a feature request for this library, file it with the GitHub issue tracker.  (You can find it on the Github page for each library, under the "Issues" tab.)  We're always expanding our libraries, and would love to hear your ideas.
+
+## Submitting Bug Reports
+If you find a problem with a library, whether you are stuck or want to address it yourself, first log it using the GitHub issue tracker.  That way, we can take a look and let you know how best to proceed, and if work is already underway on this issue.
+
+**Note:** The issue tracker is for *bugs* and *new features*, not help requests. For procedural questions - like help - see the above "Getting Help" section. 
+
+#### Reporting bugs effectively
+
+Please include as much information as you have available.  Where possible:
+  - your IDE software and library version (e.g. Visual Studio 2012, mbed Online IDE, Xively Java Lib 1.0)
+  - what device you were running the code on (e.g. iOS 5, Android 4.0, Arduino Uno)
+  - how you are connected to the web (e.g. Gainspan wireless module, Ethernet)
+  - and any more detail you have (e.g. what are the underlying versions of software stack)
+
+Mention very precisely what went wrong. For example, instead of "I can't add a datapoint", it is more helpful to say "the library returned an error 'X' when I tried datapoint.upload()".  What did you expect to happen? What happened instead? Describe the exact steps you could take to recreate it.
+
+
+## Contributing to Xively Libraries
+If you see an improvement that you can make to a library, bring it on!  All of our libraries are open-source and constantly improving, so take a look at our guidelines below and send in your contribution.
+
+### Include Tests
+All of our libraries are set up to be tested by Travis CI, with full-coverage unit tests, and integration tests where possible.  If you are going to contribute, please ensure that your contributions can be tested as well.  If you need help with this, let us know!
+
+### Use Pull Requests
+If you know exactly how to implement the feature being suggested or fix the bug
+being reported, please open a pull request instead of an issue. Pull requests are easier than
+patches or inline code blocks for discussing and merging the changes.
+
+### Contributing (Step-by-step)
+
+1) Clone the Repo of the library you want to contribute to:
+```
+git clone git://github.com/xively/xively-rb.git
+```
+2) Create a new Branch, named for the feature you're addressing or adding:
+```
+cd xively-rb
+git checkout -b new_feature_branch
+```
+3) Code:
+
+Do what you do best here!  Follow these guidelines, and be mindful of how your change will impact the whole of the library: 
+- write with testing in mind (and write tests!)
+- keep the transport layer of a library (e.g. TCP/HTTP) separate from the Xively layer (e.g. Xively Feed object)
+- make sure it won't break anything that relied on a previous version
+- check to see if documentation updates are needed
+
+4) Rebase your commits
+
+Many fixes require a multitude of commits, but when submitting a pull request, we'd prefer if you'd squash them into a single commit for readability:
+```
+git remote add upstream https://github.com/xively/xively-rb
+git fetch upstream
+git checkout new_feature_branch
+git rebase upstream/master
+git rebase -i
+```
+Choose 'squash' for all of your commits except the first one.  Edit the commit message to describe the whole of your contribution and changes.
+```
+git push origin new_feature_branch -f
+git checkout master
+git pull --rebase
+```
+
+5) Issue a Pull Request
+
+First, push your rebased single commit to your remote fork of the Xively library
+```
+git remote add mine git@github.com:<your user name>/discourse.git
+git push mine new_feature_branch
+```
+Then:
+- Navigate to the  repository you just pushed to (e.g. https://github.com/your-user-name/xively-rb)
+- Click "Pull Request"
+- Select your branch name (new_feature_branch) in the branch field
+- Click "Update Commit Range"
+- Ensure the changes you introduced are included in the "Commits" and "Files Changed" tabs
+- Fill in some details about your potential contribution including a meaningful title
+- Click "Send pull request".
+
+Once these steps are done, we'll take a look and get back to you!
+
+###Responding to Feedback
+
+The team may recommend adjustments to your code, and this is perfectly normal. Part of interacting with a healthy open-source community requires you to be open to learning new techniques and strategies; don't get discouraged! Remember: if the team suggest changes to your code, they care enough about your work that they want to include it, and hope that you can assist by implementing those revisions on your own.

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Gem dependencies specified in xively-rb.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "debugger", :platforms => [:ruby_19]
+end
+
+group :test do
+  gem "rspec"
+  gem "simplecov"
+  gem "webmock"
+end

data/LICENSE.md

@@ -0,0 +1,13 @@
+###This library is Open Source, under the BSD 3-Clause license.
+
+Copyright (c) 2013, LogMeIn Inc.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+3. Neither the names of LogMeIn, Inc., nor Xively Ltd., nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL LOGMEIN, INC. OR XIVELY LTD. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,10 @@
+[![Build Status](https://secure.travis-ci.org/xively/xively-rb.png)](http://travis-ci.org/xively/xively-rb)
+
+## Xively gem
+
+Use this gem if you would like to convert between Xively data formats or represent Xively objects in Ruby.
+You can also interact with the Xively REST API using this gem.
+
+### Documentation
+
+Documentation can be found on the [wiki](https://github.com/xively/xively-rb/wiki/Documentation).

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler/setup'
+
+#require 'rake/testtask'
+require 'rake/clean'
+require 'rake/task'
+require "rspec/core/rake_task"
+
+CLEAN.include('pkg')
+CLEAN.include('coverage')
+CLOBBER.include('html')
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+# run tests before building
+task :build => :spec
+
+namespace :spec do
+  desc "Run all specs tagged with :focus => true"
+  RSpec::Core::RakeTask.new(:focus) do |t|
+    t.rspec_opts = "--tag focus"
+    t.verbose = true
+  end
+end

data/ci/build_hudson.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+set -e
+set -u
+set -x
+#TODO: script the installation of the pre-reqs: sqlite3
+#sudo apt-get install sqlite3 libsqlite3-dev libsqlite3-ruby
+
+outdir='build_artefacts'
+rm -rf $outdir
+mkdir -p $outdir
+
+echo "started build script $0 in `$outdir` at `date`"
+
+show_platform.sh > $outdir/platform.txt 2>&1 || true
+
+echo "Running custom build.sh - install bundle, rake"
+bundle --path=.gem/
+set +e
+bundle exec rake rcov > $outdir/testtask.log
+spec_rc=$?
+set -e
+
+exit $spec_rc

data/init.rb

@@ -0,0 +1,2 @@
+require 'lib/xively-rb'
+

data/lib/xively-rb.rb

@@ -0,0 +1,44 @@
+require 'nokogiri'
+require 'multi_json'
+require 'multi_xml'
+
+$:.unshift(File.dirname(File.expand_path(__FILE__)))
+
+$KCODE = 'u' if RUBY_VERSION.to_f < 1.9
+
+require 'xively-rb/helpers'
+require 'xively-rb/base'
+require 'xively-rb/validations'
+require 'xively-rb/object_extensions'
+require 'xively-rb/nil_content'
+require 'xively-rb/exceptions'
+require 'xively-rb/string_extensions'
+require 'xively-rb/array_extensions'
+require 'xively-rb/hash_extensions'
+require 'xively-rb/templates/defaults'
+require 'xively-rb/parsers/defaults'
+require 'xively-rb/feed'
+require 'xively-rb/datastream'
+require 'xively-rb/datapoint'
+require 'xively-rb/search_result'
+require 'xively-rb/trigger'
+require 'xively-rb/key'
+require 'xively-rb/permission'
+require 'xively-rb/resource'
+
+require 'xively-rb/client'
+
+if defined?(JRUBY_VERSION)
+  MultiXml.parser = :nokogiri
+else
+  MultiXml.parser = :ox
+end
+
+if RUBY_VERSION.to_f < 1.9
+  require 'fastercsv'
+  Xively::CSV = FasterCSV
+else
+  require 'csv'
+  Xively::CSV = CSV
+end
+

data/lib/xively-rb/array_extensions.rb

@@ -0,0 +1,6 @@
+class Array
+  def split(pattern = nil, limit = nil)
+    self
+  end
+end
+

data/lib/xively-rb/base.rb

@@ -0,0 +1,52 @@
+require 'xively-rb/base/instance_methods'
+
+module Xively
+  # Provide an interface for your model objects by extending this module:
+  # extend Xively::Base
+  #
+  # This provides the following configuration class method:
+  # is_xively:
+  #   - specifies that this model represents all or part of a Xively feed
+  module Base
+
+      # Provides methods for converting between the different Xively API data formats
+      # An example for a model representing a Xively feed:
+      #
+      #   is_xively :feed
+      #
+      # A datastream
+      #
+      #   is_xively :datastream
+      #
+      # To specify custom field mappings or map methods onto a field
+      #
+      #   is_xively :feed, {:title => :my_custom_instance_method, :status => :determine_feed_state}
+      #
+      def is_xively(klass, options = {})
+        @options = options
+        case klass
+        when :feed
+          @xively_class = Xively::Feed
+        when :datastream
+          @xively_class = Xively::Datastream
+        when :datapoint
+          @xively_class = Xively::Datapoint
+        else
+          @xively_class = nil
+        end
+
+        class << self
+          def xively_mappings
+            @options
+          end
+
+          def xively_class
+            @xively_class
+          end
+        end
+
+        send :include, Xively::Base::InstanceMethods
+      end
+  end
+end
+

data/lib/xively-rb/base/instance_methods.rb

@@ -0,0 +1,28 @@
+module Xively
+  module Base
+    module InstanceMethods
+
+      # Converts a model that extends Xively::Base into it's equivalent Xively object
+      #  this can then be used to convert into xml, json or csv
+      def to_xively
+        attributes = {}
+        self.class.xively_class::ALLOWED_KEYS.each do |key|
+          attributes[key] = self.send(key) if self.respond_to?(key)
+        end
+        self.class.xively_class.new(attributes.merge(custom_xively_attributes))
+      end
+
+      protected
+
+      def custom_xively_attributes(options = {})
+        hash = {}
+        self.class.xively_mappings.each do |key, value|
+          hash[key.to_s] = self.send(value)
+        end
+        hash
+      end
+
+    end
+  end
+end
+