cropio-ruby 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df3ab04e2f1368de1fceb18ca7c84826829de720
-  data.tar.gz: cf07ed8c51da46d6626b4ed856e731a1dffed48c
+  metadata.gz: afd6f4a57445477df70033561a85459d8f7b69e2
+  data.tar.gz: 799fcb92903ae02aaa589e2209f602434032b9e9
 SHA512:
-  metadata.gz: f55888c856366020c264e828a517b6e53c29038bd6057c60a75a2907340fafea6b5c68c808421a3364826b9fdae942289805b614781667b861e0b9506df254c9
-  data.tar.gz: 2727d87c87dd21f3f9fd8e9147544c65b6bd5bd634d0cf5aadb09905627b3b000eb39baa3e7d553be3b296bfeadd972cf3b62b1a21b32841ac7c297f13dd533d
+  metadata.gz: 73783fbd5238a14da0bc6b7f00b38ac169f921abe1bf7502337b33d49cbb35f201c330a2cf4eba3eb46d5c2685d6bc0bc6ef4289e1f9981ec08f578b0535baba
+  data.tar.gz: ead1b0a204f01ec45fe396a66402040f34a32f24fa46433f19381bca4b79d4ac7dcae8c8a37bf55ec24c536c4d3fcbf5ba458292216c2d7656d54d7c9865296d

data/README.md

@@ -23,7 +23,9 @@ Or install it yourself as:
 
 Require it:
 
-    $ require 'cropio'
+```ruby
+require 'cropio'
+```
 
 To load Cropio resources to current namespace:
 
@@ -36,7 +38,7 @@ try to request some data from Cropio gem will get authentication token.
 
 ```ruby
 Cropio.credentials = {
-  email: 'your account email,
+  email: 'your account email',
   password: 'your password'
 }
 

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/cropio-ruby.gemspec

@@ -4,25 +4,32 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cropio/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cropio-ruby"
-  spec.version       = Cropio::VERSION
-  spec.authors       = ["Sergey Vernidub"]
-  spec.email         = ["info@cropio.com"]
+  spec.name = 'cropio-ruby'
+  spec.version = Cropio::VERSION
+  spec.authors = ['Sergey Vernidub']
+  spec.email = ['info@cropio.com']
 
-  spec.summary       = %q{Cropio API bindings for Ruby}
-  spec.description   = %q{Cropio-Ruby provides simple ActiveRecord-like wrappings for Cropio API}
-  spec.homepage      = "https://cropio.com"
+  spec.summary = 'Cropio API bindings for Ruby'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.description = <<STR
+Cropio-Ruby provides simple ActiveRecord-like wrappings for Cropio API
+STR
+
+  spec.homepage = 'https://cropio.com'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'json'
   spec.add_dependency 'rest-client'
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'byebug'
 end

data/lib/cropio.rb

@@ -5,11 +5,19 @@ require 'cropio/connection'
 require 'cropio/resource'
 require 'cropio/resources'
 
+# Cropio-Ruby provides simple ActiveRecord-like wrappings
+# for Cropio API. Currently it supports Cropio APIv3.
+#
+# Main gem's module Cropio contains accessors for credentials and other stuff
 module Cropio
+  # Getter for credentials
   def self.credentials
     @credentials
   end
 
+  # Setter for credentials,
+  # accepts Hash or OpenStruct with email and password or api_token
+  # as param
   def self.credentials=(credentials)
     case credentials
     when Hash

data/lib/cropio/connection/authenticable.rb

@@ -1,30 +1,36 @@
 module Cropio
   module Connection
+    # Contains authentication options for connection.
     module Authenticable
+      # Public interface for authentication request
       def authenticate!
         auth_request
       end
 
       protected
 
+      # Define wrappers around specified methods to be sure
+      # they are authenticated.
       def authenticate_before(*methods)
         methods.each do |method_name|
           unauthentificated_method = method(method_name)
           singleton_class.send(:define_method, method_name) do |*args|
-            authenticate! if !authenticated?
+            authenticate! unless authenticated?
             unauthentificated_method.call(*args)
           end
         end
       end
 
+      # Send authentication request.
       def auth_request
         process_result RestClient.post(url_for('sign_in'),
-                                  auth_request_params.to_json,
-                                  authentication_headers)
+                                       auth_request_params.to_json,
+                                       authentication_headers)
       rescue RestClient::Unauthorized => e
         process_result(e.http_body)
       end
 
+      # Process result returned by authentication request.
       def process_result(result)
         result = JSON.parse(result)
 
@@ -36,6 +42,7 @@ module Cropio
         end
       end
 
+      # Return params based on user credentials.
       def auth_request_params
         {
           user_login: {
@@ -44,18 +51,22 @@ module Cropio
           }
         }
       rescue NoMethodError => e
-        if %i(email password).include?(e.name)
-          fail "Cropio credentials is not specified: #{e.name}"
-        else
-          raise e
-        end
+        process_auth_params_error(e) || raise(e)
       end
 
+      # Returns true if user has api token.
       def authenticated?
         !Cropio.credentials.api_token.nil?
       rescue NoMethodError => e
         e.name == :api_token ? false : raise(e)
       end
+
+      # Process NoMethodError and prints norification if
+      # exeption was produced by empty credentials.
+      def process_auth_params_error(e)
+        return unless %i(email password).include?(e.name)
+        fail "Cropio credentials is not specified: #{e.name}"
+      end
     end
   end
 end

data/lib/cropio/connection/configurable.rb

@@ -1,23 +1,27 @@
 module Cropio
   module Connection
+    # Contains logic for requests configuration
+    # like appending headers to requests.
     module Configurable
-
+      # Cropio's server and API's entry point url
       BASE_URL = 'https://cropio.com/api/v3'
 
       protected
 
+      # Returns headers set for request.
       def headers
         authenticated? ? authenticated_headers : authentication_headers
       end
 
+      # Returns headers for authentication query.
       def authentication_headers
         { content_type: :json, accept: :json }
       end
 
+      # Returns headers for authenticated queries.
       def authenticated_headers
-        authentication_headers.merge({
-          'X-User-Api-Token' => Cropio.credentials.api_token
-        })
+        authentication_headers.merge(
+          'X-User-Api-Token' => Cropio.credentials.api_token)
       end
     end
   end

data/lib/cropio/connection/proxiable.rb

@@ -1,20 +1,25 @@
-require'rest-client'
+require 'rest-client'
 
 module Cropio
   module Connection
+    # Contains logic of proxing calls to HTTPS requests.
     module Proxiable
-      def get(resource, query={})
-        proxy(method: :get, url: url_for(resource), headers: {params: query})
+      # Accepts reources name and params to perform HTTPS GET request.
+      def get(resource, query = {})
+        proxy(method: :get, url: url_for(resource), headers: { params: query })
       end
 
+      # Accepts reources name and params to perform HTTPS POST request.
       def post(resource, data)
         proxy(method: :post, url: url_for(resource), data: data)
       end
 
+      # Accepts reources name and params to perform HTTPS PATCH request.
       def patch(resource, data)
         proxy(method: :patch, url: url_for(resource), data: data)
       end
 
+      # Accepts reources name and params to perform HTTPS DELETE request.
       def delete(resource)
         proxy(method: :delete, url: url_for(resource))
       end
@@ -41,12 +46,12 @@ module Cropio
 
       def proxy_post(options)
         RestClient.post(options[:url],
-                        {data: options[:data]}, options[:headers])
+                        { data: options[:data] }, options[:headers])
       end
 
       def proxy_patch(options)
         RestClient.patch(options[:url],
-                          {data: options[:data]}, options[:headers])
+                         { data: options[:data] }, options[:headers])
       end
 
       def proxy_delete(options)

data/lib/cropio/connection/proxy.rb

@@ -1,5 +1,7 @@
 module Cropio
   module Connection
+    # Encapsulates communication with Cropio API.
+    # Proxies calls to API as HTTPS requests.
     class Proxy
       extend Authenticable
       extend Configurable

data/lib/cropio/misc/string_inflector.rb

@@ -1,21 +1,24 @@
 module Cropio
+  # StringInflector contains operations for strings.
+  # We think it is bad idea to require active_support for this.
   class StringInflector
     class << self
       def underscore(string)
         string
           .gsub(/::/, '/')
-          .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-          .gsub(/([a-z\d])([A-Z])/,'\1_\2')
-          .tr("-", "_")
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
           .downcase
       end
 
-      # simple implementation - for resources plural form only
+      # Returns pluralized form for word passed as param.
+      # It is simple implementation - for resources plural forms only.
       def pluralize(string)
         if string[-1] == 'y'
-          "#{ string[0..(string.length - 2)] }ies"
+          "#{string[0..(string.length - 2)]}ies"
         else
-          "#{ string }s"
+          "#{string}s"
         end
       end
     end

data/lib/cropio/resource/attributes.rb

@@ -1,5 +1,6 @@
 module Cropio
   module Resource
+    # Defines accessors for resource attrubutes.
     module Attributes
       def self.included(base)
         base.send(:attr_accessor, :attributes)
@@ -36,7 +37,7 @@ module Cropio
       end
 
       def define_attribute_getter(attribute_name)
-        eval "
+        instance_eval "
           def #{attribute_name}
             attributes['#{attribute_name}']
           end
@@ -44,7 +45,7 @@ module Cropio
       end
 
       def define_attribute_setter(attribute_name)
-        eval "
+        instance_eval "
           def #{attribute_name}=(val)
             attributes['#{attribute_name}'] = val
           end
@@ -52,7 +53,7 @@ module Cropio
       end
 
       def define_attribute_question(attribute_name)
-        eval "
+        instance_eval "
           def #{attribute_name}?
             !attributes['#{attribute_name}'].nil?
           end
@@ -61,8 +62,8 @@ module Cropio
 
       def method_missing(name, *attrs, &block)
         name = name.to_s
-        attr_name = name.gsub('=', '')
-        if attributes.has_key?(attr_name)
+        attr_name = name.delete('=')
+        if attributes.key?(attr_name)
           define_attributes_accessors
           name == attr_name ? send(name) : send(name, attrs.first)
         else

data/lib/cropio/resource/base.rb

@@ -1,81 +1,94 @@
 module Cropio
   module Resource
+    # Represents ActiveRecord::Base-like model's class
+    # with Cropio data selection and mutation.
     class Base
       include Attributes
 
-      Proxy = Cropio::Connection::Proxy
-      Limit = 1000
+      PROXY = Cropio::Connection::Proxy
+      LIMIT = 1000
 
-      def initialize(attributes={})
+      def initialize(attributes = {})
         self.attributes = attributes
       end
 
+      # Returns name of Resource
       def self.resource_name
         @resource_name ||= StringInflector.underscore(name.split('::').last)
       end
 
+      # Return pluralized version of Resource's name
       def self.resources_name
         @resources_name ||= StringInflector.pluralize(resource_name)
       end
 
+      # Get all resources.
       def self.all
         to_instances(get_all_chunks)
       end
 
+      # Count all resources.
       def self.count
         all.count
       end
 
-      def self.select(options={})
-      end
-
+      # Returns persistance of the resource.
+      # Resource is persisted if it is saved
+      # and not deleted, if this resource exists
+      # on Cropio servers.
       def persisted?
-        if @persisted.nil?
-          @persisted = false
-        end
-
-        @persisted
+        @persisted.nil? && (@persisted ||= false)
       end
 
+      # Saves current resource to Cropio.
       def save
-        self.attributes = if persisted?
-          Proxy.patch("#{resources_name}/#{id}", attributes)
-        else
-          @persisted = true
-          Proxy.post(resources_name, attributes)
-        end
+        self.attributes =
+          if persisted?
+            PROXY.patch("#{resources_name}/#{id}", attributes)
+          else
+            @persisted = true
+            PROXY.post(resources_name, attributes)
+          end
       end
 
+      # Remove this resource from Cropio.
       def destroy
         if persisted?
-          Proxy.delete("#{resources_name}/#{id}")
+          PROXY.delete("#{resources_name}/#{id}")
           @persisted = false
           true
         else
-          raise 'Cropio record is not persisted!'
+          fail 'Cropio record is not persisted!'
         end
       end
 
       private
+
+      # Returns pluralized name of own type.
       def resources_name
         self.class.resources_name
       end
 
-      def self.get_all_chunks(options={})
+      # Download resources from Cropio by Chunks.
+      def self.get_all_chunks(options = {})
         response = nil
         buffer = []
-        limit = options[:limit] || (2 ** 32 - 1)
-        while is_data?(response) && limit > 0
-          chunk_size = limit < Limit ? limit : Limit
-          limit -= chunk_size
-          offset = buffer.any? ? buffer.last['id'] + 1 : 0
-          response = get_chunk(limit: chunk_size, from_id: offset)
+        limit = options[:limit] || (2**32 - 1)
+        while data?(response) && limit > 0
+          limit -= limit < LIMIT ? limit : LIMIT
+          response = get_chunk(limit: limit, from_id: offset(buffer))
           buffer += response['data']
         end
         buffer
       end
 
-      def self.is_data?(response=nil)
+      # Gets offset for next chunk during download.
+      def self.offset(buffer)
+        buffer.any? ? buffer.last['id'] + 1 : 0
+      end
+
+      # Returns false if chunk is not empty.
+      def self.data?(response = nil)
         if response.nil?
           true
         else
@@ -83,17 +96,21 @@ module Cropio
         end
       end
 
+      # Download chunk from Cropio.
       def self.get_chunk(options)
-        Proxy.get(resources_name, limit: options[:limit],
-                    from_id: options[:from_id])
+        PROXY.get(resources_name,
+                  limit: options[:limit],
+                  from_id: options[:from_id])
       end
 
+      # Converts each received attribute's hash to resources.
       def self.to_instances(attr_sets)
         attr_sets.map do |attr_set|
           to_instance(attr_set)
         end
       end
 
+      # Converts specified attribute's hash to resource.
       def self.to_instance(attr_set)
         new(attr_set).tap do |resource|
           resource.instance_eval do

data/lib/cropio/resources.rb

@@ -28,6 +28,6 @@ require_relative './resources/seed'
 require_relative './resources/user'
 
 module Cropio
-  module CropioResources
+  module Resources
   end
 end

data/lib/cropio/version.rb

@@ -1,3 +1,3 @@
 module Cropio
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cropio-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Sergey Vernidub
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2015-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -94,7 +94,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Cropio-Ruby provides simple ActiveRecord-like wrappings for Cropio API
+description: |
+  Cropio-Ruby provides simple ActiveRecord-like wrappings for Cropio API
 email:
 - info@cropio.com
 executables: []