syncano 3.1.1.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b60ab5d1367c53ed95d4be884d3e4db7bde5259
+  data.tar.gz: 393e5d874af1e291d5281a4072b95654024aae2b
+SHA512:
+  metadata.gz: 4a2f19cb61eea646089ec03a2fbd2dc21e84b3425d699e2ca8b29afa8eacbd3e4c868ca8a00bcaa0e91fca80e25a4c29041dc1deb49168a32c060cdbbe8ad0d7
+  data.tar.gz: 49755d9f9a68ac8c6ca5d4778e4d0925ae0f8447b7e976399e3cd69972d37876ac23e450525784013e7f07dece271c7d739cd63ef65b81b8972be7765695f36f

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store
+.com.apple.timemachine.supported
+.idea/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in syncano.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Piotr Zadrożny
+
+MIT License
+
+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/README.md

@@ -0,0 +1,304 @@
+# Syncano
+
+Syncano ruby gem provides communication with Syncano ([www.syncano.com](www.syncano.com)) via HTTPS RESTful interface and TCP sockets.
+
+The full source code can be found on [Github](https://github.com/Syncano/syncano-ruby) - feel free to browse or contribute.
+
+Click here to learn more about [Syncano](www.syncano.com) or [create an account](https://login.syncano.com/sign_up)!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'syncano'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install syncano
+    
+At the end generate initializer with api key and api instance name:
+
+    $ rails g syncano:install
+
+Initializer is not obligatory - you can provide both parameters directly in the client's constructor.
+
+## Usage
+
+### Clients
+
+There are two different class of clients. One for JSON RPC interface and one for socket connections with Sync Server. You can use both in quite similar way:
+
+```ruby
+client = Syncano.client
+
+client = Syncano.sync_client
+```
+    
+You can provide specific api credentials when you are initializing your client:
+
+```ruby
+client = Syncano.client(api_key: 'api key', instance_name: 'instance name')
+
+client = Syncano.sync_client(api_key: 'api key', instance_name: 'instance name')
+```
+
+Sync client has some additional features like:
+
+* managing connections
+```ruby
+client.connect
+client.reconnect
+client.disconnect
+```
+* managing callbacks for handling notifications (it is described later in this document)
+
+### Resources
+
+Syncano gem utilizes an ActiveRecord pattern for managing resources. You can use it in similar way with both type of clients.
+
+Below is a list of standard methods implemented in resources.
+
+* objects.all(parameters)
+* objects.count(parameters)
+* objects.first(parameters)
+* objects.last(parameters)
+* objects.find(id)
+* objects.new(attributes)
+* objects.create(attributes)
+* object.update(attributes)
+* object.save
+* object.destroy
+
+Some of resources do not implement all standard methods and others have some custom methods, ie. data_object.copy.
+
+Every resource has attributes which can be accessed as a hash ie.:
+
+* object[:attribute]
+* object[:attribute] = 'value'
+* object.attributes = { attribute: 'value' }
+
+Below is a list of all implemented resources with information about what methods are implemented and usage examples.
+
+#### Project
+
+Implements all standard methods.
+
+##### Examples
+
+* Getting all projects
+
+```ruby
+Syncano.projects.all
+```
+
+* Creating a project
+
+```ruby
+Syncano.projects.create(name: 'Project name')
+```
+
+* Updating a project
+
+```ruby
+project[:description] = 'Lorem ipsum'
+project.save
+```
+
+#### Collection
+
+Implements all standard methods and following custom:
+
+* collections.find_by_key(collection_key)
+* collection.activate
+* collection.deactivate
+* collection.add_tag(tag, weight, remove_others)
+* collection.delete_tag(tag)
+
+##### Examples
+
+* Getting all
+
+```ruby
+project.collections.all
+```
+
+* Finding by key
+
+```ruby
+project.collections.find_by_key(collection_key)
+```
+
+* Activating
+
+```ruby
+collection.activate
+```
+
+* Adding tags
+
+```ruby
+collection1.add_tags(['tag1', 'tag2'], 3)
+collection2.add_tags('tag3', 1, true)
+```
+
+#### Folder
+
+Implements all standard methods and following custom:
+
+* folders.find_by_name(folder_name)
+
+Find method uses folder name as a key.
+
+##### Examples
+
+* Getting one
+
+```ruby
+collection.folders.find(folder_name)
+collection.folders.find_by_name(folder_name)
+```
+
+#### Data object
+
+Implements all standard methods and following custom:
+
+* data_objects.find_by_key(data_object_key)
+* data_objects.move(data_object_ids, new_folder, new_state)
+* data_object.move(new_folder, new_state)
+* data_objects.copy(data_object_ids)
+* data_object.copy
+* data_object.add_parent(parent_id, remove_other)
+* data_object.remove_parent(parent_id)
+* data_object.add_child(parent_id, remove_other)
+* data_object.remove_child(parent_id)
+
+##### Examples
+
+* Moving data object to the new folder
+
+```ruby
+data_object.move('new_folder')
+```
+
+* Copying two data objects
+
+```ruby
+collection.data_objects.copy([112, 3871])
+```
+
+* Adding parent to the data object
+
+```ruby
+data_object.add_parent(parent_object_id, true)
+```
+
+#### Admin
+
+Implements all standard methods and following custom:
+
+* admin.find_by_email(email)
+
+#### Api key
+
+Implements all standard methods.
+
+#### Role
+
+Implements only following standard methods:
+
+* role.all
+* role.first
+* role.last
+* role.count
+
+#### User
+
+Implements all standard methods.
+
+### Batch requests
+
+It is possible to make batch requests to the JSON RPC endpoint. You do not have to care about batch requests limits specified in the Syncano api docs. This library will care about queuing for you.
+
+```ruby
+client = Syncano.client
+responses = client.batch do |queue|
+  queue << collection.batch.save
+  queue << collection.data_objects.batch.create(title: 'Lorem ipsum')
+  queue.add(data_object.batch.destroy)
+end
+```
+
+There is no difference between "queue.add" and "queue <<" methods.
+
+In the above example variable responses will contain three Syncano::Response objects.
+Remember that batch responses do not change objects used in batch requests. If you want to see changes you have to reload them:
+
+```ruby
+collection.reload
+```
+
+### Notifications
+
+Main advantage of using Sync Server are real time notifications. This concept is well described in the Syncano api documentation.
+
+#### Subscriptions
+
+Before you will receive any notification, you have to subscribe to some project or collection:
+
+```ruby
+client = Syncano.sync_client
+project = client.project.find(project_id)
+project.subscribe
+```
+
+If you want to stop receiving notifications, you have to unsubscribe:
+```ruby
+project.unsubscribe
+```
+
+You can also list all active subscriptions:
+```ruby
+client.subscriptions.all
+```
+
+#### Handling notifications
+
+Notifications are handled by callbacks passed to the sync client:
+
+```ruby
+client.append_callback(:callback_name) do |notification|
+  p "We have received a new notification #{notification.inspect}! Yaaay!"
+end
+```
+
+Callbacks form a queue. You can add new callback to the end of the queue (like above) or to the beginning:
+
+```ruby
+client.prepend_callback(:callback_name) do |notification|
+  p "We have received a new notification #{notification.inspect}! Yaaay!"
+end
+```
+
+To delete callback from the queue just call remove_callback method:
+ 
+```ruby
+client.remove_callback(:callback_name)
+```
+
+### Errors and exceptions
+
+This library does not implement any validations. All errors from the api will cause throwing an exception.
+It is thought that user will create his own validation mechanisms specific not only for restrictions imposed by the Syncano, but also for his own logic.
+It can be compared to the exceptions after violating constraints in the MySQL database.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/lib/generators/syncano/install_generator.rb

@@ -0,0 +1,17 @@
+module Syncano
+  # Module for generators used implemented in the gem
+  module Generators
+    # Install generator used for initializing gem in a Rails application
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Copies templates for initializers
+      def create_initializers
+        Dir["#{self.class.source_root}/initializers/*.rb"].each do |filepath|
+          name = File.basename(filepath)
+          template "initializers/#{name}", "config/initializers/#{name}"
+        end
+      end
+    end
+  end
+end

data/lib/generators/syncano/templates/initializers/syncano.rb

@@ -0,0 +1,4 @@
+# Syncano instance name
+SYNCANO_INSTANCE_NAME = 'instance_name'
+# Syncano api key
+SYNCANO_API_KEY = 'api_key'

data/lib/syncano.rb

@@ -0,0 +1,92 @@
+require 'syncano/version'
+
+# Main class used for instantizing clients and as scope for other classes
+class Syncano
+  # Used for initializing Syncano Rest Client
+  # @param [Hash] options with keys: instance_name, api_key which can be also provided as constants in the initializer
+  # @return [Syncano::Clients::Rest] Syncano client.
+  def self.client(options = {})
+    auth_data = self.auth_data(options)
+    Syncano::Clients::Rest.new(auth_data[:instance_name], auth_data[:api_key])
+  end
+
+  # Used for initializing Syncano Sync Client
+  # @param [Hash] options with keys: instance_name, api_key which can be also provided as constants in the initializer
+  # @return [Syncano::Clients::Rest] Syncano client.
+  def self.sync_client(options = {})
+    auth_data = self.auth_data(options)
+    client = Syncano::Clients::Sync.instance(auth_data[:instance_name], auth_data[:api_key])
+    client.connect
+    client
+  end
+
+  private
+
+  # Prepares hash with auth data from options or constants in initializer
+  # @param [Hash] options with keys: instance_name, api_key which can be also provided as constants in the initializer
+  # @return [Hash]
+  def self.auth_data(options = {})
+    instance_name = options[:instance_name] || ::SYNCANO_INSTANCE_NAME
+    raise 'Syncano instance name cannot be blank!' if instance_name.nil?
+
+    api_key = options[:api_key] || ::SYNCANO_API_KEY
+    raise 'Syncano api key cannot be blank!' if api_key.nil?
+
+    { instance_name: instance_name, api_key: api_key }
+  end
+end
+
+# Jimson client
+require 'jimson/client'
+require 'syncano/jimson_client'
+
+# Multi Json
+require 'multi_json'
+
+# Eventmachine
+require 'eventmachine'
+
+# Singleton
+require 'singleton'
+
+# ActiveSupport
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/class/attribute.rb'
+require 'active_support/core_ext/object/blank.rb'
+require 'active_support/json/decoding.rb'
+require 'active_support/json/encoding.rb'
+require 'active_support/time_with_zone.rb'
+
+# Syncano
+require 'syncano/errors'
+require 'syncano/clients/base'
+require 'syncano/clients/rest'
+require 'syncano/clients/sync'
+require 'syncano/sync_connection'
+require 'syncano/query_builder'
+require 'syncano/batch_queue'
+require 'syncano/batch_queue_element'
+require 'syncano/response'
+require 'syncano/resources/base'
+require 'syncano/resources/admin'
+require 'syncano/resources/api_key'
+require 'syncano/resources/data_object'
+require 'syncano/resources/collection'
+require 'syncano/resources/folder'
+require 'syncano/resources/project'
+require 'syncano/resources/role'
+require 'syncano/resources/subscription'
+require 'syncano/resources/user'
+require 'syncano/packets/base'
+require 'syncano/packets/auth'
+require 'syncano/packets/call'
+require 'syncano/packets/call_response'
+require 'syncano/packets/error'
+require 'syncano/packets/message'
+require 'syncano/packets/notification'
+require 'syncano/packets/ping'
+require 'syncano/resources/notifications/base'
+require 'syncano/resources/notifications/create'
+require 'syncano/resources/notifications/update'
+require 'syncano/resources/notifications/destroy'
+require 'syncano/resources/notifications/message'