apphoshies-ruby-client 0.4.0 → 0.5.0

data/History.txt

@@ -21,3 +21,7 @@
 === 0.4.0
 
 * File Upload Support
+
+=== 0.5.0
+
+* Refactoring, Addition of all basic system objects

data/Manifest.txt

@@ -4,10 +4,14 @@ PostInstall.txt
 README.rdoc
 Rakefile
 lib/apphoshies_client.rb
-lib/apphoshies_client/class_methods.rb
 lib/apphoshies_client/configuration.rb
+lib/apphoshies_client/exceptions.rb
+lib/apphoshies_client/base.rb
 lib/apphoshies_client/device_token.rb
 lib/apphoshies_client/document.rb
+lib/apphoshies_client/content_item.rb
+lib/apphoshies_client/tracking_item.rb
+lib/apphoshies_client/user.rb
 lib/apphoshies_client/message.rb
 lib/apphoshies_client/file_upload.rb
 script/console

data/README.rdoc

@@ -4,15 +4,37 @@
 
 == DESCRIPTION:
 
-The App Hoshies infrastructure is based on REST Webservices. For your convenience client frameworks are provided to interact with your data.
+The App Hoshies App Data Cloud is based on REST Webservices. For your convenience client frameworks are provided to interact with your data (iOS/Android/Ruby). At the moment the App Data Cloud is in private beta mode. Please contact support (at) apphoshies (dot) com if you want to try it out.
+
+Please visit http://apphoshies.com/service for more information.
 
 == FEATURES/PROBLEMS:
 
-* Documents, Device Tokens, Documents
+* Documents, Device Tokens, Documents, Messages
 
 == SYNOPSIS:
+	Create an apphoshies.yml in the current directory or an .apphoshies.yml file in your home directory
+
+	@@apphoshies_configuration = ApphoshiesClient::Configuration.new
+	@@apphoshies_configuration.config
+
+	document = ApphoshiesClient::Document.find_one(params[:some_id])
+	documents = ApphoshiesClient::Document.all(:datasource => 'test', :limit => 10)
+
+	Creating a push message for a single device
+	
+	message = ApphoshiesClient::Message.new(:app_id => 'Your App Name', :application_client_key => 'the target device key', :message => 'Your Message')
+	message.save
+
+	Sending a push message to all devices of an app
 
-  FIX (code sample of usage)
+	message = ApphoshiesClient::Message.new(:app_id => 'Your App Name', :application_client_key => 'all', :message => 'Your Message')
+	message.save
+	
+	Retrieving a file uploads of a user (identified by the application_client_key of the app installation)
+	
+	file_uploads = ApphoshiesClient::FileUpload.find_by_application_client_key('the target device key', {:document_id => 'document id association'})
+    puts file_uploads.first.url
 
 == REQUIREMENTS:
 

data/lib/apphoshies_client.rb

@@ -2,7 +2,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module ApphoshiesClient
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end
 
 require "rubygems"
@@ -11,7 +11,7 @@ require 'active_resource'
 
 ActiveResource::Base.include_root_in_json = true
 
-require 'apphoshies_client/class_methods'
+require 'apphoshies_client/exceptions'
 require 'apphoshies_client/configuration'
 @@apphoshies_configuration = ApphoshiesClient::Configuration.new
 @@apphoshies_configuration.site = 'https://service.apphoshies.com'
@@ -19,7 +19,17 @@ require 'apphoshies_client/configuration'
 @@apphoshies_configuration.api_key = ''
 @@apphoshies_configuration.app_id = ''
 
+require 'apphoshies_client/base'
 require 'apphoshies_client/device_token'
 require 'apphoshies_client/document'
+require 'apphoshies_client/content_item'
+require 'apphoshies_client/user'
+require 'apphoshies_client/tracking_item'
 require 'apphoshies_client/message'
 require 'apphoshies_client/file_upload'
+
+#def load_development_configuration
+#  @@apphoshies_configuration = ApphoshiesClient::Configuration.new
+#	@@apphoshies_configuration.config
+#	@@apphoshies_configuration.site = 'http://192.168.0.104:3000'
+#end

data/lib/apphoshies_client/base.rb

@@ -0,0 +1,33 @@
+class ApphoshiesClient::Base < ActiveResource::Base
+  def self.get(query_symbol, options = {})
+    reload_http_headers
+    
+    if @@apphoshies_configuration.app_id.blank? or @@apphoshies_configuration.username.blank? or @@apphoshies_configuration.api_key.blank?
+      raise ApphoshiesClient::MissingCredentialsException, 'Username, API Key and App Id required!'
+    end
+
+    return find(query_symbol, :params => {:app_id => @@apphoshies_configuration.app_id}) if query_symbol.is_a?(String)
+    default_options = {:app_id => @@apphoshies_configuration.app_id, :limit => 100}
+    find(:all, :params => default_options.merge(options))
+  end
+  
+  def self.all(options = {})
+    get(:all, options)
+  end
+  
+  def self.find_one(id); get(id); end
+  
+  def self.find_by_application_client_key(application_client_key, options = {})
+    default_options = {:app_id => @@apphoshies_configuration.app_id, :application_client_key => application_client_key}
+    get(:all, options)
+  end
+
+  def self.find_by_datasource(datasource, options = {})
+    get(:all, options.merge(:datasource => datasource)) if datasource
+  end
+
+  def self.reload_http_headers
+    headers['APH_USERNAME'] = @@apphoshies_configuration.username
+    headers['APH_API_KEY'] = @@apphoshies_configuration.api_key
+  end
+end

data/lib/apphoshies_client/configuration.rb

@@ -20,7 +20,7 @@ class ApphoshiesClient::Configuration
         puts "Using config in your home directory"
         @config = YAML.load(File.read("#{ENV['HOME']}/.apphoshies.yml"))
       rescue Errno::ENOENT
-        puts ">>> apphoshies.yml expected in current directory or ~/.apphoshies.yml"
+        raise ApphoshiesClient::MissingConfigurationException, "apphoshies.yml expected in current directory or ~/.apphoshies.yml"
       end
     end
   end

data/lib/apphoshies_client/content_item.rb

@@ -0,0 +1,7 @@
+class ApphoshiesClient::ContentItem < ApphoshiesClient::Document
+  self.element_name = "document"
+
+  def self.all(options = {})
+    find_by_datasource('content_items', options)
+  end
+end

data/lib/apphoshies_client/device_token.rb

@@ -1,13 +1,15 @@
-class ApphoshiesClient::DeviceToken < ActiveResource::Base
-  extend ClassMethods
-  
+class ApphoshiesClient::DeviceToken < ApphoshiesClient::Base
   self.site = @@apphoshies_configuration.site
   self.format = :json
   headers['APH_USERNAME'] = @@apphoshies_configuration.username
   headers['APH_API_KEY'] = @@apphoshies_configuration.api_key
-  
+
   def self.find_by_application_client_key(application_client_key, options = {})
-    default_options = {:app_id => @@apphoshies_configuration.app_id, :application_client_key => application_client_key}
-    find(:all, :params => default_options.merge(options))
+    default_options = {:limit => 1, :application_client_key => application_client_key}
+    unless application_client_key.blank?
+      get(:all, default_options.merge(options))
+    else
+      raise ApphoshiesClient::MissingApplicationClientKeyException
+    end
   end
 end

data/lib/apphoshies_client/document.rb

@@ -1,30 +1,17 @@
-class ApphoshiesClient::Document < ActiveResource::Base
-  extend ClassMethods
-
+class ApphoshiesClient::Document < ApphoshiesClient::Base
   self.site = @@apphoshies_configuration.site
   self.format = :json
   headers['APH_USERNAME'] = @@apphoshies_configuration.username
   headers['APH_API_KEY'] = @@apphoshies_configuration.api_key
-  
-  def self.get(query_symbol, options = {})
-    reload_http_headers
-    return find(query_symbol, :params => {:app_id => @@apphoshies_configuration.app_id}) if query_symbol.is_a?(String)
-    default_options = {:app_id => @@apphoshies_configuration.app_id, :limit => 100}
-    find(:all, :params => default_options.merge(options))
-  end
 
   def self.all(options = {})
-    reload_http_headers
-    get(:all, options)
+    if options and options[:datasource]
+      find_by_datasource(options[:datasource], options)
+    else
+      raise ApphoshiesClient::MissingDatasourceException, 'Please provide a datasource option!'
+    end
   end
 
-  def self.find_by_datasource(datasource, options = {})
-    reload_http_headers
-    get(:all, options.merge(:datasource => datasource))
-  end
-  
-  def self.find_one(id); get(id); end
-  
   def get_value(key)
     if self.values
       v = self.values.select {|value_object| value_object.respond_to?(key.to_sym)}
@@ -36,9 +23,16 @@ class ApphoshiesClient::Document < ActiveResource::Base
     _values = self.values.collect {|v| v.attributes}
     if value.is_a?(String)
       _values << {key => value, "type" => value.class.name.to_s}
-      # TODO check other types!
+    elsif value.is_a?(Fixnum)
+      _values << {key => value, "type" => 'Integer'}
+    elsif value.is_a?(Float)
+      _values << {key => value, "type" => 'Float'}
+    elsif value.is_a?(TrueClass) or value.is_a?(FalseClass)
+      _values << {key => value, "type" => 'Boolean'}
+    elsif value.is_a?(DateTime)
+      _values << {key => value, "type" => 'DateTime'}
     else
-      raise "Value type not supported yet!"
+      raise ApphoshiesClient::ValueTypeNotSupportedException
     end
     self.values = _values
   end
@@ -54,10 +48,4 @@ class ApphoshiesClient::Document < ActiveResource::Base
       return nil
     end
   end
-  
-  private
-  def self.reload_http_headers
-    headers['APH_USERNAME'] = @@apphoshies_configuration.username
-    headers['APH_API_KEY'] = @@apphoshies_configuration.api_key
-  end
 end

data/lib/apphoshies_client/exceptions.rb

@@ -0,0 +1,5 @@
+class ApphoshiesClient::MissingCredentialsException < Exception; end
+class ApphoshiesClient::MissingApplicationClientKeyException < Exception; end
+class ApphoshiesClient::MissingConfigurationException < Exception; end
+class ApphoshiesClient::MissingDatasourceException < Exception; end
+class ApphoshiesClient::ValueTypeNotSupportedException < Exception; end

data/lib/apphoshies_client/file_upload.rb

@@ -1,33 +1,19 @@
-class ApphoshiesClient::FileUpload < ActiveResource::Base
-  extend ClassMethods
-
+class ApphoshiesClient::FileUpload < ApphoshiesClient::Base
   self.site = @@apphoshies_configuration.site
   self.format = :json
   headers['APH_USERNAME'] = @@apphoshies_configuration.username
   headers['APH_API_KEY'] = @@apphoshies_configuration.api_key
 
   def url
-    "https://service.apphoshies.com/file_uploads/#{self.id}"
+    "#{@@apphoshies_configuration.site}/file_uploads/#{self.id}"
   end
 
   def self.find_by_application_client_key(application_client_key, options = {})
-    reload_http_headers
-    default_options = {:app_id => @@apphoshies_configuration.app_id, :application_client_key => application_client_key}
-    find(:all, :params => default_options.merge(options))
-  end
-  
-  def self.find_one(id); get(id); end
-  
-  def self.get(query_symbol, options = {})
-    reload_http_headers
-    return find(query_symbol, :params => {:app_id => @@apphoshies_configuration.app_id}) if query_symbol.is_a?(String)
-    default_options = {:app_id => @@apphoshies_configuration.app_id, :limit => 100}
-    find(:all, :params => default_options.merge(options))
-  end
-  
-  private
-  def self.reload_http_headers
-    headers['APH_USERNAME'] = @@apphoshies_configuration.username
-    headers['APH_API_KEY'] = @@apphoshies_configuration.api_key
+    default_options = {:limit => 100, :application_client_key => application_client_key}
+    unless application_client_key.blank?
+      get(:all, default_options.merge(options))
+    else
+      raise ApphoshiesClient::MissingApplicationClientKeyException
+    end
   end
 end

data/lib/apphoshies_client/message.rb

@@ -1,13 +1,15 @@
-class ApphoshiesClient::Message < ActiveResource::Base
-  extend ClassMethods
-
+class ApphoshiesClient::Message < ApphoshiesClient::Base
   self.site = @@apphoshies_configuration.site
   self.format = :json
   headers['APH_USERNAME'] = @@apphoshies_configuration.username
   headers['APH_API_KEY'] = @@apphoshies_configuration.api_key
 
   def self.find_by_application_client_key(application_client_key, options = {})
-    default_options = {:app_id => @@apphoshies_configuration.app_id, :application_client_key => application_client_key}
-    find(:all, :params => default_options.merge(options))
+    default_options = {:limit => 100, :last_check_at => 1440, :application_client_key => application_client_key}
+    unless application_client_key.blank?
+      get(:all, default_options.merge(options))
+    else
+      raise ApphoshiesClient::MissingApplicationClientKeyException
+    end
   end
 end

data/lib/apphoshies_client/tracking_item.rb

@@ -0,0 +1,7 @@
+class ApphoshiesClient::TrackingItem < ApphoshiesClient::Document
+  self.element_name = "document"
+
+  def self.all(options = {})
+    find_by_datasource('tracking_items', options)
+  end
+end

data/lib/apphoshies_client/user.rb

@@ -0,0 +1,7 @@
+class ApphoshiesClient::User < ApphoshiesClient::Document
+  self.element_name = "document"
+
+  def self.all(options = {})
+    find_by_datasource('users', options)
+  end
+end

data/script/console

@@ -7,4 +7,5 @@ libs =  " -r irb/completion"
 # libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
 libs <<  " -r #{File.dirname(__FILE__) + '/../lib/apphoshies_client.rb'}"
 puts "Loading apphoshies_client gem"
-exec "#{irb} #{libs} --simple-prompt"
+exec "#{irb} #{libs} --simple-prompt"
+

data/test/test_apphoshies_client.rb

@@ -1,11 +1,10 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-class TestApphoshiesClient < Test::Unit::TestCase
-
-  def setup
-  end
-  
-  def test_truth
-    assert true
-  end
-end
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestApphoshiesClient < Test::Unit::TestCase
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: apphoshies-ruby-client
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Oliver Kiessler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-17 00:00:00 +01:00
+date: 2010-12-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,7 +66,10 @@ dependencies:
         version: 2.6.1
   type: :development
   version_requirements: *id003
-description: The App Hoshies infrastructure is based on REST Webservices. For your convenience client frameworks are provided to interact with your data.
+description: |-
+  The App Hoshies App Data Cloud is based on REST Webservices. For your convenience client frameworks are provided to interact with your data (iOS/Android/Ruby). At the moment the App Data Cloud is in private beta mode. Please contact support (at) apphoshies (dot) com if you want to try it out.
+  
+  Please visit http://apphoshies.com/service for more information.
 email: 
 - kiessler@apphoshies.com
 executables: []
@@ -84,10 +87,14 @@ files:
 - README.rdoc
 - Rakefile
 - lib/apphoshies_client.rb
-- lib/apphoshies_client/class_methods.rb
 - lib/apphoshies_client/configuration.rb
+- lib/apphoshies_client/exceptions.rb
+- lib/apphoshies_client/base.rb
 - lib/apphoshies_client/device_token.rb
 - lib/apphoshies_client/document.rb
+- lib/apphoshies_client/content_item.rb
+- lib/apphoshies_client/tracking_item.rb
+- lib/apphoshies_client/user.rb
 - lib/apphoshies_client/message.rb
 - lib/apphoshies_client/file_upload.rb
 - script/console
@@ -129,7 +136,7 @@ rubyforge_project: apphoshies-ruby-client
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: The App Hoshies infrastructure is based on REST Webservices
+summary: The App Hoshies App Data Cloud is based on REST Webservices
 test_files: 
 - test/test_apphoshies_client.rb
 - test/test_helper.rb

data/lib/apphoshies_client/class_methods.rb

@@ -1,2 +0,0 @@
-module ClassMethods
-end