cloud_connect 2.0.2 → 3.0.3

data/.gitignore

@@ -1,6 +1,23 @@
-pkg/*
 *.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.\#*
 .bundle
+.config
 .yardoc
-.DS_Store
-doc/*
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags

data/Gemfile

@@ -1,2 +1,3 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
+
 gemspec

data/Gemfile.lock

@@ -1,46 +1,57 @@
 PATH
   remote: .
   specs:
-    cloud_connect (2.0.0)
-      faraday (~> 0.8.0)
-      faraday_middleware (~> 0.8.0)
-      hashie (~> 1.2.0)
-      json (~> 1.8.0)
-      multi_json (~> 1.10.0)
+    cloud_connect (3.0.0)
+      addressable (~> 2.2)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.8)
+      hashie (~> 1.2)
+      multi_json
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    bluecloth (2.2.0)
-    diff-lcs (1.2.5)
-    faraday (0.8.9)
-      multipart-post (~> 1.2.0)
-    faraday_middleware (0.8.8)
+    addressable (2.3.2)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
       faraday (>= 0.7.4, < 0.9)
     hashie (1.2.0)
-    json (1.8.1)
-    multi_json (1.10.1)
-    multipart-post (1.2.0)
-    rake (0.9.6)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.3)
+    json (1.7.5)
+    maruku (0.6.1)
+      syntax (>= 1.0.0)
+    multi_json (1.3.7)
+    multipart-post (1.1.5)
+    rake (10.0.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    syntax (1.0.0)
+    webmock (1.9.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    yard (0.8.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bluecloth (>= 2.0)
-  bundler (>= 1.0.0)
   cloud_connect!
-  rake (~> 0.8)
+  json (~> 1.7)
+  maruku
+  rake
   rspec
+  simplecov
+  webmock
+  yard

data/README.md

@@ -1,97 +1,42 @@
-The Coud Connect Ruby Gem
-==========================
+# CloudConnect
+Simple Ruby wrapper for the CloudConnect v3 API.
 
-A Ruby wrapper for the [Cloud Connect API](http://develop.g8teway.com).
+## Installation
 
-Installation
-------------
-    gem install cloud_connect
+```bash
+gem install cloud_connect
+```
 
-Usage
------
+## Documentation
 
-    require 'rubygems'
-    require 'cloud_connect'
+http://rdoc.info/gems/cloud_connect
 
-### Instantiate a client
+## Authenticated Requests
 
-    cloud_connect = CloudConnect::Client.new(:username => 'user', :password => 'password', :account => 'test', :env => 'sandbox')
+### Setup a client with your token
 
-### Or configure once
+```ruby
+cc = CloudConnect::Client.new(:account => "demo", :token => "token")
+cc.asset("imei")
+```
 
-    CloudConnect.configure do |config|
-      config.username = 'user'
-      config.password = 'password'
-      config.account  = 'test'
-      config.env      = 'sandbox'
-    end
-    cloud_connect = CloudConnect.client.new
+## Examples
 
-### Login
+### Show an asset
 
-    cloud_connect.login
+```ruby
+cc.asset("imei")
+=> #<Hashie::Mash imei="imei" name=nil serial=nil url="http://url.cloudconnect.io/api/v3/assets/imei">
+```
 
-### Examples
+### Show last messages for an asset
 
-    cloud_connect.units
-    =>  [<#Hashie::Mash id=2 lat=nil lng=nil time=nil>, <#Hashie::Mash id=3 lat=4884481 lng=226392 time="2009-07-08T10:23:13Z">]
+```ruby
+cc.messages(asset:"imei")
+```
 
-Details for the current user
-    cloud_connect.user
+### Channels
 
-Details for another user
-
-    cloud_connect.user('other_user')
-    cloud_connect.user(1)
-
-Send a message to a unit
-
-    cloud_connect.send_message(1, 11, "Hello World!")
-
-Get a unit's last known position
-
-    unit = cloud_connect.unit(3)
-    puts "#{unit.location.join(', ')} @ #{unit.time}"
-
-We recommand you install the [yajl-ruby](http://github.com/brianmario/yajl-ruby) Gem
-for improved performance over the default pure ruby JSON library.
-
-Contributing
-------------
-In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
-
-Here are some ways *you* can contribute:
-
-* by using alpha, beta, and prerelease versions
-* by reporting bugs
-* by suggesting new features
-* by writing or editing documentation
-* by writing specifications
-* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
-* by refactoring code
-* by closing [issues](http://github.com/mobile-devices/cloud_connect/issues)
-* by reviewing patches
-
-All contributors will be added to the [HISTORY](https://github.com/mobile-devices/cloud_connect/blob/master/HISTORY.md)
-file and will receive the respect and gratitude of the community.
-
-Submitting an Issue
--------------------
-We use the [GitHub issue tracker](http://github.com/mobile-devices/cloud_connect/issues) to track bugs and
-features. Before submitting a bug report or feature request, check to make sure it hasn't already
-been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
-bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
-details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
-operating system. Ideally, a bug report should include a pull request with failing specs.
-
-Submitting a Pull Request
--------------------------
-1. Fork the project.
-2. Create a topic branch.
-3. Implement your feature or bug fix.
-4. Add documentation for your feature or bug fix.
-5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
-6. Add specs for your feature or bug fix.
-7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
-8. Commit and push your changes.
-9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+```
+cc.channels
+```

data/Rakefile

@@ -1,47 +1,19 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
 namespace :doc do
   require 'yard'
   YARD::Rake::YardocTask.new do |task|
-    task.files   = ['lib/cloud_connect.rb', 'lib/cloud_connect/**/*.rb']
+    task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
     task.options = [
-      '--protected',
       '--output-dir', 'doc/yard',
-      '--tag', 'format:Supported formats',
-      '--tag', 'authenticated:Requires Authentication',
-      '--tag', 'rate_limited:Rate Limited',
       '--markup', 'markdown',
     ]
   end
 end
-
-task :irb do
-  $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-  require 'irb'
-  require 'bundler/setup'
-  require 'cloud_connect'
-  module IRB # :nodoc:
-    def self.start_session(binding)
-      unless @__initialized
-        args = ARGV
-        ARGV.replace(ARGV.dup)
-        IRB.setup(nil)
-        ARGV.replace(args)
-        @__initialized = true
-      end
-
-      ws  = WorkSpace.new(binding)
-      irb = Irb.new(ws)
-
-      @CONF[:IRB_RC].call(irb.context) if @CONF[:IRB_RC]
-      @CONF[:MAIN_CONTEXT] = irb.context
-
-      catch(:IRB_EXIT) do
-        irb.eval_input
-      end
-    end
-
-    IRB.start_session(binding)
-  end
-end

data/cloud_connect.gemspec

@@ -1,31 +1,30 @@
-require File.expand_path("../lib/cloud_connect/version", __FILE__)
+# encoding: utf-8
+require File.expand_path('../lib/cloud_connect/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name        = "cloud_connect"
-  s.version     = CloudConnect::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Jean-Paul Bonnetouche"]
-  s.email       = ["alexandre.mora@mobile-devices.fr"]
-  s.homepage    = "http://rubygems.org/gems/cloud_connect"
-  s.summary     = "Wrapper for Cloud Connect"
-  s.description = "Ruby Wrapper for the Mobile Devices Cloud Connect API"
-  s.version     = '2.0.2'
+Gem::Specification.new do |gem|
+  gem.add_dependency 'addressable', '~> 2.2'
+  gem.add_dependency 'faraday', '~> 0.8'
+  gem.add_dependency 'faraday_middleware', '~> 0.8'
+  gem.add_dependency 'hashie', '~> 1.2'
+  gem.add_dependency 'multi_json'
+  gem.add_development_dependency 'json', '~> 1.7'
+  gem.add_development_dependency 'maruku'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'yard'
+  gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
 
-  s.required_rubygems_version = ">= 1.3.6"
-
-  s.add_runtime_dependency "json", "~> 1.8.0"
-  s.add_runtime_dependency "multi_json", "~> 1.10.0"
-  s.add_runtime_dependency "faraday", "~> 0.8.0"
-  s.add_runtime_dependency "faraday_middleware", "~> 0.8.0"
-  s.add_runtime_dependency "hashie", "~> 1.2.0"
-
-  s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "bluecloth", ">= 2.0"
-  s.add_development_dependency "rake", "~> 0.8"
-  #s.add_development_dependency "yard", "~> 0.6"
-  s.add_development_dependency "rspec"
-
-  s.files        = `git ls-files`.split("\n")
-  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
-  s.require_path = 'lib'
+  gem.authors       = ['Jean-Paul Bonnetouche']
+  gem.summary       = 'Wrapper for the CloudConnect v3 API'
+  gem.description   = 'Simple wrapper for the CloudConnect v3 API'
+  gem.email         = ['jean-paul.bonnetouche@mobile-devices.fr']
+  gem.files         = `git ls-files`.split("\n")
+  gem.homepage      = 'https://github.com/mobile-devices/cloud_connect'
+  gem.name          = 'cloud_connect'
+  gem.platform      = Gem::Platform::RUBY
+  gem.require_paths = ['lib']
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.version       = CloudConnect::VERSION
 end

data/lib/cloud_connect/authentication.rb

@@ -0,0 +1,15 @@
+module CloudConnect
+  module Authentication
+    def authentication
+      if token
+        {:token => token}
+      else
+        {}
+      end
+    end
+
+    def authenticated?
+      !authentication.empty?
+    end
+  end
+end

data/lib/cloud_connect/client/assets.rb

@@ -0,0 +1,102 @@
+module CloudConnect
+  class Client
+    module Assets
+      # Get an asset
+      #
+      # @param imei [String] IMEI of the asset
+      # @return [Asset] The asset you requested, if it exists
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0003-assets
+      # @example Get asset 0123456789012345
+      #   @client = CloudConnect::Client.new(:account => 'foor', :token => 'bar')
+      #   @client.asset("0123456789012345")
+      def asset(imei, options={})
+        enhance( get("assets/#{imei}", options), with: AssetMethods )
+      end
+
+      # Search assets
+      #
+      # @param search_term [String] The term to search for
+      # @return [Array] A list of assets matching the search term
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0003-assets
+      # @example Search for '123' in the assets
+      #   @client = CloudConnect::Client.new(:account => 'foor', :token => 'bar')
+      #   @client.search_assets
+      def search_assets(search_term, options={})
+        enhance( get("assets?q=#{search_term}", options), with: AssetMethods )
+      end
+
+      # Get assets
+      #
+      # @return [Array] A list of all assets
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0003-assets
+      # @example List all assets
+      #   @client = CloudConnect::Client.new(:account => 'foor', :token => 'bar')
+      #   @client.list_assets
+      def assets(options={})
+        enhance( get("assets", options), with: AssetMethods )
+      end
+      alias :list_assets :assets
+
+      # Create an asset
+      #
+      # @param imei [String] IMEI of the asset
+      # @param options [Hash] A customizable set of options
+      # @options options [String] :name Name of the asset
+      # @options options [String] :serial Serial number of the asset
+      # @options options [String] :description Description of the asset
+      # @return [Asset] Your newly created asset
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0003-assets#create_a_new_asset
+      # @example Create a new Asset
+      #   @client = CloudConnect::CloudConnect.new(:account => 'foo', :token => 'bar')
+      #   @client.create_asset("359551033822346", :name => 'General Lee', :serial => "50030000005322", :description => "The Dukes of Hazzard")
+      def create_asset(imei, options={})
+        enhance( post("assets", options.merge({:imei => imei})), with: AssetMethods )
+      end
+
+      # Update an asset
+      #
+      # @param imei [String] IMEI of the asset
+      # @param options [Hash] A customizable set of options
+      # @options options [String] :name Name of the asset
+      # @options options [String] :serial Serial number of the asset
+      # @options options [String] :description Description of the asset
+      # @return [Asset] Your newly updated asset
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0003-assets#update_an_asset
+      # @example Update an Asset
+      #   @client = CloudConnect::CloudConnect.new(:account => 'foo', :token => 'bar')
+      #   @client.update_asset("359551033822346", :name => 'General Lee', :serial => "50030000005322", :description => "The Dukes of Hazzard")
+      def update_asset(imei, options={})
+        enhance( put("assets/#{imei}", options.merge({:imei => imei})), with: AssetMethods )
+      end
+
+      # Delete a single asset
+      #
+      # @param imei [String] IMEI fo the field
+      # @return [Response] A response object with status
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0003-assets#delete_an_asset
+      # @example Delete the "359551033822346" asset
+      #   @client = CloudConnect::CloudConnect.new(:account => 'foo', :token => 'bar')
+      #   @client.delete_asset("359551033822346")
+      def delete_asset(imei, options={})
+        delete("assets/#{imei}", options, true)
+      end
+
+      module AssetMethods
+        extend CustomMethods
+        # Send a message to the unit
+        #
+        # @param channel [String] Channel for the message
+        # @param payload [String] Payload of the message to send
+        # @return [Message] The message
+        # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0005-messages#push_a_message_to_an_asset
+        def send_message(channel, payload, opts = {})
+          _client.send_message(imei, channel, payload, opts)
+        end
+
+        def messages(opts = {})
+          _client.messages(opts.merge asset: imei)
+        end
+      end
+    end
+  end
+end

data/lib/cloud_connect/client/channels.rb

@@ -1,22 +1,89 @@
 module CloudConnect
-  module Channels
+  class Client
+    module Channels
+      # Get a channel
+      #
+      # @param name [String] Name of the channel
+      # @return [Channel] The channel you requested, if it exists
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0006-channels
+      # @example Get channel 0123456789012345
+      #   @client = CloudConnect::Client.new(:account => 'foo', :token => 'bar')
+      #   @client.channel("0123456789012345")
+      def channel(name, options={})
+        enhance( get("channels/#{name}", options), with: ChannelMethods )
+      end
 
-    # Retrieve list of channels
-    # WARNING: This method uses calls not officially supported by Mobile Devices.
-    #
-    # @return [Array of Hashie::Mash] Channels
-    def channels(reload = false)
-      return @channels if @channels && !reload
-      page  = 1
-      limit = 100
-      channels = []
-      while (slice = connection.get(connection.build_url("channels", :per_page => limit, :page => page)).body).size > 0
-        page += 1
-        channels += slice.map!{|hash| hash.values.first} if slice.size > 0
-        slice.size < limit ? break : sleep(1)
+      # Search channels
+      #
+      # @param search_term [String] The term to search for
+      # @return [Array] A list of channels matching the search term
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0006-channels
+      # @example Search for 'com.mdi.services.adminProtocol' in the channels
+      #   @client = CloudConnect::Client.new(:account => 'foor', :token => 'bar')
+      #   @client.search_channels
+      def search_channels(search_term, options={})
+        enhance( get("channels?q=#{search_term}", options), with: ChannelMethods )
+      end
+
+      # Get channels
+      #
+      # @return [Array] A list of all channels
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0003-channels
+      # @example List all channels
+      #   @client = CloudConnect::Client.new(:account => 'foo', :token => 'bar')
+      #   @client.channels
+      def channels(options={})
+        enhance( get("channels", options), with: ChannelMethods )
+      end
+      alias :list_channels :channels
+
+      # Create a channel
+      #
+      # @param name [String] Name of the channel
+      # @param options [Hash] A customizable set of options
+      # @options options [Integer] :msgttl    The delay in seconds before the message is considered expired (and will not be sent)
+      # @options options [Integer] :unitack   The delay in seconds for acknowledgment by the asset (after the message has been sent)
+      # @options options [Integer] :serverack The delay in seconds for acknowledgment by the server (after the message has been sent)
+      # @return [Channel] Your newly created channel
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0007-channels#create_a_new_channel
+      # @example Create a new Channel
+      #   @client = CloudConnect::CloudConnect.new(:account => 'foo', :token => 'bar')
+      #   @client.create_channel("weather")
+      def create_channel(name, options={})
+        enhance( post("channels", options.merge({:name => name})), with: ChannelMethods )
       end
-      @channels = channels.sort_by(&:channel)
-    end
 
+      # Update a channel
+      #
+      # @param name [String] Name of the channel
+      # @param options [Hash] A customizable set of options
+      # @options options [Integer] :msgttl    The delay in seconds before the message is considered expired (and will not be sent)
+      # @options options [Integer] :unitack   The delay in seconds for acknowledgment by the asset (after the message has been sent)
+      # @options options [Integer] :serverack The delay in seconds for acknowledgment by the server (after the message has been sent)
+      # @return [Channel] Your newly updated channel
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0007-channel#update_a_channel
+      # @example Update a Channel
+      #   @client = CloudConnect::CloudConnect.new(:account => 'foo', :token => 'bar')
+      #   @client.create_channel("weather", :msgttl => 123, ...)
+      def update_channel(name, options={})
+        enhance( put("channels/#{name}", options.merge({:name => name})), with: ChannelMethods )
+      end
+
+      # Delete a single channel
+      #
+      # @param name [String] Name fo the channel
+      # @return [Response] A response object with status
+      # @see http://wordsabout.it/mobile-devices/cloudconnect-user-documentation/cc-0006-channels#delete_a_channel
+      # @example Delete the CUSTOM_SENSOR_TEMP channel
+      #   @client = CloudConnect::CloudConnect.new(:account => 'foo', :token => 'bar')
+      #   @client.delete_channel("com.acmecorp.weather")
+      def delete_channel(name, options={})
+        delete("channels/#{name}", options, true)
+      end
+
+      module ChannelMethods
+        extend CustomMethods
+      end
+    end
   end
 end

data/lib/cloud_connect/client/configurations.rb

@@ -0,0 +1,54 @@
+module CloudConnect
+  class Client
+    module Configurations
+      # Get a configuration
+      #
+      # @param id [String] ID of the configuration
+      # @return [Configuration] The configuration you requested, if it exists
+      def configuration(id, options={})
+        enhance( get("configs/#{id}", options), with: ConfigurationMethods )
+      end
+
+      # Search configurations
+      #
+      # @param search_term [String] The term to search for
+      # @return [Array] A list of configurations matching the search term
+      def search_configurations(search_term, options={})
+        enhance( get("configs?q=#{search_term}", options), with: ConfigurationMethods )
+      end
+
+      # Create a configuration
+      #
+      # @param name [String] Name of the configuration
+      # @options options [Hash] :data JSON data of the config
+      # @options options [Array] :imeis list of assets concerned by this configuration
+      # @return [Field] Your newly created configuration
+      def create_configuration(name, options={})
+        enhance( post("configs", options.merge(name: name)), with: ConfigurationMethods )
+      end
+
+      # Update a configuration
+      #
+      # @param id [String] Id of the configuration
+      # @options options [String] Name of the configuration
+      # @options options [Hash] :data JSON data of the config
+      # @options options [Array] :imeis list of assets concerned by this configuration
+      # @return [Field] Your newly created configuration
+      def update_configuration(id, options={})
+        enhance( put("configs/#{id}", options), with: ConfigurationMethods )
+      end
+
+      # Get all configurations
+      #
+      # @return [Array] A list of all configurations
+      def configurations(options={})
+        enhance( get("configs", options), with: ConfigurationMethods )
+      end
+      alias :list_configurations :configurations
+
+      module ConfigurationMethods
+        extend CustomMethods
+      end
+    end
+  end
+end

data/lib/cloud_connect/client/custom_methods.rb

@@ -0,0 +1,20 @@
+module CustomMethods
+  # @private
+  def extended(base)
+    # FIXME: Useless time consuming (especially for arrays)...
+    base.class.send(:attr_accessor, :_client) unless base.respond_to?(:_client)
+  end
+
+  # @private
+  # By extending CustomMethods in YourModule, you are able to call
+  # YourModule.apply_to(object_or_array) to add YourModule methods to the
+  # object or to all objects in the array.
+  def apply_to(receiver, client_opts)
+    case receiver
+    when Array
+      receiver.each{|a| a.extend self; a._client = client_opts[:client]}
+    when Hashie::Mash
+      receiver.extend self; receiver._client = client_opts[:client]
+    end
+  end
+end