cloud_connect 2.0.2 → 3.0.3

data/lib/cloud_connect/request.rb

@@ -0,0 +1,70 @@
+require 'multi_json'
+
+module CloudConnect
+  module Request
+    def delete(path, options={}, raw=false, force_urlencoded=false)
+      request(:delete, path, options, raw, force_urlencoded)
+    end
+
+    def get(path, options={}, raw=false, force_urlencoded=false)
+      request(:get, path, options, raw, force_urlencoded)
+    end
+
+    def patch(path, options={}, raw=false, force_urlencoded=false)
+      request(:patch, path, options, raw, force_urlencoded)
+    end
+
+    def post(path, options={}, raw=false, force_urlencoded=false)
+      request(:post, path, options, raw, force_urlencoded)
+    end
+
+    def put(path, options={}, raw=false, force_urlencoded=false)
+      request(:put, path, options, raw, force_urlencoded)
+    end
+
+    private
+
+      def request(method, path, options, raw, force_urlencoded)
+        path.sub(%r{^/}, '') # prevent leading slash
+        response = connection(raw, force_urlencoded).send(method) do |request|
+          request.headers['Accept'] = 'application/json'
+
+          case method
+          when :delete, :get
+            if auto_traversal && per_page.nil?
+              self.per_page = 100
+            end
+            options.merge!(:per_page => per_page) if per_page
+            request.url(path, options)
+          when :patch, :post, :put
+            request.path = path
+            if !force_urlencoded
+              request.body = MultiJson.dump(options) unless options.empty?
+            else
+              request.body = options unless options.empty?
+            end
+            puts request.inspect
+          end
+
+          request.headers['Host'] = CloudConnect.request_host if CloudConnect.request_host
+        end
+
+        if raw
+          response
+        elsif auto_traversal && ( next_url = links(response)["next"] )
+          response.body + request(method, next_url, options, raw, force_urlencoded)
+        else
+          response.body
+        end
+      end
+
+      def links(response)
+        links = ( response.headers["Link"] || "" ).split(', ').map do |link|
+          url, type = link.match(/<(.*?)>; rel="(\w+)"/).captures
+          [ type, url ]
+        end
+
+        Hash[ *links.flatten ]
+      end
+  end
+end

data/lib/cloud_connect/version.rb

@@ -1,3 +1,3 @@
 module CloudConnect
-  VERSION = "2.0.2"
+  VERSION = '3.0.3' unless defined?(CloudConnect::VERSION)
 end

data/lib/cloud_connect.rb

@@ -1,43 +1,26 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'forwardable'
-
-begin
-  require 'yajl'
-  MultiJson.engine = :yajl
-rescue LoadError
-  require 'json'
-  MultiJson.engine = :json_gem
-end
+require 'cloud_connect/configuration'
+require 'cloud_connect/client'
+require 'cloud_connect/notification'
+require 'cloud_connect/error'
 
 module CloudConnect
+  extend Configuration
   class << self
-    attr_accessor :username
-    attr_accessor :password
-    attr_accessor :account
-    attr_accessor :version
-    attr_accessor :env
-
-    def configure
-      yield self
-      true
+    # Alias for CloudConnect::Client.new
+    #
+    # @return [CloudConnect::Client]
+    def new(options={})
+      CloudConnect::Client.new(options)
     end
 
-    require 'ext/object'
-    require 'ext/module'
-    require 'ext/hash'
-
-    require 'faraday/cookie_auth'
-    require 'faraday/raise_http_4xx'
-    require 'faraday/raise_http_5xx'
+    # Delegate to CloudConnect::Client.new
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
 
-    require 'cloud_connect/error'
-    require 'cloud_connect/client/units'
-    require 'cloud_connect/client/users'
-    require 'cloud_connect/client/messages'
-    require 'cloud_connect/client/trackings'
-    require 'cloud_connect/client/channels'
-    require 'cloud_connect/client/fields'
-    require 'cloud_connect/client'
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
   end
 end

data/lib/faraday/response/raise_cloud_connect_error.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'multi_json'
+
+# @api private
+module Faraday
+  class Response::RaiseCloudConnectError < Response::Middleware
+    def on_complete(response)
+      case response[:status].to_i
+      when 400
+        raise CloudConnect::BadRequest, error_message(response)
+      when 401
+        raise CloudConnect::Unauthorized, error_message(response)
+      when 403
+        raise CloudConnect::Forbidden, error_message(response)
+      when 404
+        raise CloudConnect::NotFound, error_message(response)
+      when 406
+        raise CloudConnect::NotAcceptable, error_message(response)
+      when 422
+        raise CloudConnect::UnprocessableEntity, error_message(response)
+      when 500
+        raise CloudConnect::InternalServerError, error_message(response)
+      when 501
+        raise CloudConnect::NotImplemented, error_message(response)
+      when 502
+        raise CloudConnect::BadGateway, error_message(response)
+      when 503
+        raise CloudConnect::ServiceUnavailable, error_message(response)
+      end
+    end
+
+    def error_message(response)
+      message = if (body = response[:body]) && !body.empty?
+        if body.is_a?(String)
+          body = MultiJson.load(body, :symbolize_keys => true)
+        end
+        " #{body[:title]}: #{body[:message]} Error(s): [#{body[:errors].join(", ")}]"
+      else
+        ''
+      end
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{message}"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_connect
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,15 +26,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,15 +42,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,15 +58,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,31 +74,47 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: maruku
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,15 +122,15 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bluecloth
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,25 +138,57 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -155,38 +203,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby Wrapper for the Mobile Devices Cloud Connect API
+description: Simple wrapper for the CloudConnect v3 API
 email:
-- alexandre.mora@mobile-devices.fr
+- jean-paul.bonnetouche@mobile-devices.fr
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .yardopts
 - Gemfile
 - Gemfile.lock
-- HISTORY.md
 - README.md
 - Rakefile
 - cloud_connect.gemspec
 - lib/cloud_connect.rb
+- lib/cloud_connect/authentication.rb
 - lib/cloud_connect/client.rb
+- lib/cloud_connect/client/assets.rb
 - lib/cloud_connect/client/channels.rb
+- lib/cloud_connect/client/configurations.rb
+- lib/cloud_connect/client/custom_methods.rb
 - lib/cloud_connect/client/fields.rb
 - lib/cloud_connect/client/messages.rb
-- lib/cloud_connect/client/trackings.rb
-- lib/cloud_connect/client/units.rb
-- lib/cloud_connect/client/users.rb
+- lib/cloud_connect/client/tracks.rb
+- lib/cloud_connect/configuration.rb
+- lib/cloud_connect/connection.rb
 - lib/cloud_connect/error.rb
+- lib/cloud_connect/notification.rb
+- lib/cloud_connect/notification/notification.rb
+- lib/cloud_connect/request.rb
 - lib/cloud_connect/version.rb
-- lib/ext/hash.rb
-- lib/ext/module.rb
-- lib/ext/object.rb
-- lib/faraday/cookie_auth.rb
-- lib/faraday/raise_http_4xx.rb
-- lib/faraday/raise_http_5xx.rb
-homepage: http://rubygems.org/gems/cloud_connect
+- lib/faraday/response/raise_cloud_connect_error.rb
+homepage: https://github.com/mobile-devices/cloud_connect
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -209,6 +257,6 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Wrapper for Cloud Connect
+summary: Wrapper for the CloudConnect v3 API
 test_files: []
 has_rdoc: 

data/.yardopts

@@ -1,7 +0,0 @@
-'lib/cloud_connect.rb' 'lib/cloud_connect/**/*.rb'
---no-private
---protected
---tag format:"Supported formats"
---tag authenticated:"Requires Authentication"
---tag rate_limited:"Rate Limited"
---markup markdown

data/HISTORY.md

@@ -1,33 +0,0 @@
-2.0.2 - August 22, 2014
------------------------
-* Add support for old school APIs (v1.5)
-
-2.0.1 - August 13, 2014
------------------------
-* Update faraday from 0.5.1 to 0.8.9
-* Update faraday_middleware from 0.1.7 to 0.8.8
-* Update multi_json from 0.0.5 to 1.10.1
-* Update hashie from 0.4.0 to 1.2.0
-
-2.0.0 - December 6, 2011
-------------------------
-* Release current version as 2.0.0 (Synchronise with CloudConnect v2) for reference before "branching" for 3.0.0 (CloudConnect v3),
-  to ease integration and documentation.
-
-0.0.2 - March 22, 2011
-----------------------
-* [Removed HTTP status debug log](https://github.com/mobile-devices/cloud_connect/commit/1d032259d16b82749fe595bfa0a15f05bb8af65a) ([@dohzya][http://twitter.com/#!/dohzya])
-* [Fixed bad links in README](https://github.com/mobile-devices/cloud_connect/commit/326416c0dcc3e444f6bb4cefbd5a63d83f2e5aa0)
-
-0.0.1 - February 16, 2011
--------------------------
-* Initial release
-
-Thanks to the following people for making this possible
--------------------------------------------------------
-- John Nunemaker ([@jnunemaker](http://twitter.com/#!/jnunemaker))
-  for the twitter gem that inspired this one.
-- Rick Olson ([@technoweenie](https://github.com/technoweenie))
-  for the faraday gem
-- Wynn Netherland ([@pengwynn](http://github.com/pengwynn))
-  for the faraday_middleware gem

data/lib/cloud_connect/client/trackings.rb

@@ -1,22 +0,0 @@
-module CloudConnect
-  module Trackings
-
-    # Retrieve list of tracking data
-    #
-    # @see http://develop.g8teway.com/p/tracking_records.html#listing_tracking_records
-    # @param [Hash] opts the options to filter the tracking data.
-    # @options opts [String] :ret Select attributes to fetch
-    # @options opts [String] :userids List of unit ids
-    # @options opts [String] :fieldids List of field ids
-    # @options opts [Integer] :from Minimum ID
-    # @options opts [Integer] :to Maximum ID
-    # @options opts [Integer] :id_min Minimum ID
-    # @options opts [Integer] :id_max Maximum ID
-    # @options opts [Integer] :limit Number of elements to fetch (default 25
-    # @return [Array of Hashie::Mash] Tracking data
-    def trackings(opts = {})
-      trackings = connection.get(connection.build_url("tracking_records", opts)).body
-      trackings.map!{|hash| hash.values.first}
-    end
-  end
-end

data/lib/cloud_connect/client/units.rb

@@ -1,77 +0,0 @@
-module CloudConnect
-  module Units
-
-    # Returns all units that match parameters provided in +opts+ list
-    # (if +opts+ is provided)
-    #
-    # @param [Hash] opts the options to filter the units.
-    # @option opts [String] :ret ('id, lat, long, time') Select attributes to fetch
-    # @option opts [String] :unitids List of unit ids
-    # @option opts [String] :fieldids List of field ids
-    # @option opts [String] :unknow Allow unknown position
-    # @option opts [Integer] :id_min Minimum ID
-    # @option opts [Integer] :id_max Maximum ID
-    # @option opts [Integer] :limit Number of elements to fetch (default 25
-    # @return [Array<Hashie::Mash>] Units
-    # @see http://develop.g8teway.com/p/units.html#listing_units
-    def units(opts = {})
-      units = connection.get(connection.build_url("units", opts)).body
-      units.map!{|hash| hash.values.first}
-      units.each{|u| u.extend UnitMethods; u._cloud_connect = self;}
-    end
-
-    # Search for a specific unit knowing it's modid
-    #
-    # @param [String] modids the comma separated list modids.
-    #   Partial modids can be provided using the '*' caracter
-    # @example
-    #   find_unit("*3216*")
-    # @return [Array<Hashie::Mash>] Unit
-    # @see http://develop.g8teway.com/p/units.html#searching_units
-    def find_units(modids)
-      # TODO: Rename unit_search?
-      units = connection.get(connection.build_url("units/search", :modids => modids)).body
-      units.map!{|hash| hash.values.first}
-      units.each{|u| u.extend UnitMethods; u._cloud_connect = self;}
-    end
-
-    # Return information about a specific unit
-    #
-    # @param [String] unit_id Unit ID
-    # @param [Hash] opts the options to filter the units.
-    # @option opts [String] :ret ('id, lat, long, time') Select attributes to fetch
-    # @option opts [String] :fieldids List of field ids
-    # @option opts [String] :unknow Allow unknown position
-    # @return [Hashie::Mash] Unit info
-    def unit(unit_id=nil, opts = {})
-      units = connection.get(connection.build_url("units", opts.merge(:unitids => unit_id))).body
-      units.map!{|hash| hash.values.first}
-      units.each{|u| u.extend UnitMethods; u._cloud_connect = self;}
-      units.first
-    end
-
-    module UnitMethods
-      # @private
-      attr_accessor :_cloud_connect
-
-      # Return the last known location of a specific unit
-      #
-      # @return [Integer lat, Integer long] Latitude, Longitude
-      def location
-        [lat.to_f / 100_000, lng.to_f / 100_000]
-      end
-
-      # Send a message to the unit
-      #
-      # @param [Integer] channel
-      # @param [String] content
-      # @param [Hash] opts
-      # @return [Hashie::Mash] The message
-      # @see http://develop.g8teway.com/p/messages.html#sending_a_new_message
-      def send_message(channel, content, opts = {})
-        raise "Unknown unit id, try providing :ret => 'id' when fetching units from the API." unless id && id > 0
-        _cloud_connect.send_message(id, channel, content, opts)
-      end
-    end
-  end
-end

data/lib/cloud_connect/client/users.rb

@@ -1,36 +0,0 @@
-module CloudConnect
-  module Users
-
-    # Retrieve list of users
-    #
-    # @see http://develop.g8teway.com/p/users.html#searching_and_listing_users
-    # @param [Hash] opts the options to filter the units.
-    # @options opts [String] :ret Select attributes to fetch
-    # @options opts [String] :userids List of unit ids
-    # @options opts [String] :logins List of field ids
-    # @options opts [Integer] :id_min Minimum ID
-    # @options opts [Integer] :id_max Maximum ID
-    # @options opts [Integer] :limit Number of elements to fetch (default 25
-    # @return [Array of Hashie::Mash] Users
-    def users(opts = {})
-      opts.default! :ret => %w(id login email).join(',')
-      users = connection.get(connection.build_url('users', opts)).body
-      users.map!{|hash| hash.values.first}
-    end
-
-    # Return information about a specific user
-    #
-    # @param [String] user_id Unit ID
-    # @return [Hashie::Mash] User info
-    def user(user_id = nil)
-      user_id = username if user_id.nil? || user_id == ""
-      if user_id.to_i.to_s == user_id.to_s
-        users = connection.get(connection.build_url('users', :userids => user_id)).body
-      else
-        users = connection.get(connection.build_url('users', :logins => user_id)).body
-      end
-      users.map!{|hash| hash.values.first}
-      users.first
-    end
-  end
-end

data/lib/ext/hash.rb

@@ -1,5 +0,0 @@
-class Hash
-  def default!(other_hash)
-    merge!( other_hash ){|k,o,n| o }
-  end
-end