activeresource-google_spreadsheets 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e0556a89297114ca3f0a98c5e7b2ec582fbdcce
-  data.tar.gz: 015504c5967d2a903225c2960866683dd3304a1f
+  metadata.gz: 532729ef07bce877223dd5be8b7b9ca86d2759f6
+  data.tar.gz: 0418b8eb8fc8bea6d0c0600bf930f0641d29340a
 SHA512:
-  metadata.gz: 9900a1b1a1f57b07ce2eeb30e7e2ff7f092f7bb028d3900ffc6ca66e8c9600689e319cfd03d522b16c12538a8b01ec355487a25e550bd0913364d22de133908e
-  data.tar.gz: fffb23b5aa36a4c8beb9a9935544955215b0b83a4f04fe05fea482d52cf4e28236ed1eb31266d5b1aad78008c1e1083ee55d50d53ed775536d9fa77db6890961
+  metadata.gz: 0382a122b75e1c62c5a85ed38e58dc35907a7db1e6cf8d43c2280d139e117972534a6f941e47a8640ea1e3eac3aad6a9ebaa62827e70734e489829ddd999f706
+  data.tar.gz: d5684ee8736054c9816b41bfa30b2c097d99b774774dc9f6bebdea8e71557a856aafce95ee8fa895bf94e3193e4080d63c718add570e6b47bec7e9d2043c00dd

data/README.md

@@ -20,7 +20,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+http://webos-goodies.jp/archives/active_resource_google_spreadsheets_data_api.html
+
+### ActiveRecord Syncing Feature (Experimental)
+
+http://qiita.com/tkawa/items/04fc6f0574122d4a3fd2
 
 ## Contributing
 

data/lib/google_spreadsheets.rb

@@ -1,5 +1,5 @@
 require 'google_spreadsheets/version'
-require 'active_support'
+require 'active_support/all'
 require 'active_resource'
 require 'time'
 require 'erb'
@@ -14,6 +14,9 @@ module GoogleSpreadsheets
   autoload :Worksheet
   autoload :List
 
+  autoload :Enhanced
+  autoload :LinkRelations
+
   class BaseError < StandardError
     DefaultMessage = nil
     def initialize(message=nil)

data/lib/google_spreadsheets/enhanced.rb

@@ -0,0 +1,10 @@
+module GoogleSpreadsheets
+  module Enhanced
+    autoload :Spreadsheet, 'google_spreadsheets/enhanced/spreadsheet'
+    autoload :Worksheet,   'google_spreadsheets/enhanced/worksheet'
+    autoload :Row,         'google_spreadsheets/enhanced/row'
+    autoload :Collection,  'google_spreadsheets/enhanced/collection'
+    autoload :NamespacePreservable, 'google_spreadsheets/enhanced/namespace_preservable'
+    autoload :Synchronizer, 'google_spreadsheets/enhanced/synchronizer'
+  end
+end

data/lib/google_spreadsheets/enhanced/collection.rb

@@ -0,0 +1,33 @@
+require 'ostruct'
+
+module GoogleSpreadsheets
+  module Enhanced
+    class Collection < ActiveResource::Collection
+      def find(id)
+        if block_given?
+          to_a.find{|*block_args| yield(*block_args) }
+        else
+          find_by!(id: id)
+        end
+      end
+
+      def find_by(condition_hash)
+        to_a.find do |element|
+          # TODO: compare with consideration of type cast
+          condition_hash.all?{|attr, value| element.send(attr) == value }
+        end
+      end
+
+      def find_by!(condition_hash)
+        find_by(condition_hash) ||
+          raise(ActiveResource::ResourceNotFound.new(OpenStruct.new(message: "Couldn't find #{self.class.name} with #{condition_hash}")))
+      end
+
+      def where(condition_hash)
+        condition_hash.inject(self.to_a) do |array, (attr, value)|
+          array.find_all{|element| element.send(attr) == value }
+        end
+      end
+    end
+  end
+end

data/lib/google_spreadsheets/enhanced/namespace_preservable.rb

@@ -0,0 +1,134 @@
+require 'nokogiri'
+
+module GoogleSpreadsheets
+  module Enhanced
+    module NamespacePreservable
+      extend ActiveSupport::Concern
+
+      class Format < GoogleSpreadsheets::GDataFormat
+        def decode(xml)
+          xml.force_encoding('UTF-8') # cf. http://d.hatena.ne.jp/kitamomonga/20101218/ruby_19_net_http_encoding
+          e = hash_from_xml_with_namespace(xml)
+          if e.has_key?('feed')
+            e = e['feed']['entry'] || []
+            (e.is_a?(Array) ? e : [e]).each{|i| format_entry(i) }
+          else
+            format_entry(e['entry'])
+          end
+        end
+
+        def encode(hash, options = {})
+          super(hash.select{|key, _| key.match(/^gsx:(.+)/) },
+                { :namespaces => { 'gsx' => 'http://schemas.google.com/spreadsheets/2006/extended' } })
+        end
+
+        private
+
+        # convert to Hash from XML including namespace
+        # https://gist.github.com/baroquebobcat/1603671
+        def hash_from_xml_with_namespace(xml_io)
+          begin
+            result = Nokogiri::XML(xml_io)
+            { result.root.name => xml_node_to_hash(result.root) }
+          rescue Exception => e
+            # raise your custom exception here
+            raise
+          end
+        end
+
+        def xml_node_to_hash(node)
+          # If we are at the root of the document, start the hash
+          if node.element?
+            result_hash = {}
+
+            node.attributes.each do |key, attr|
+              result_hash[attr.namespaced_name] = prepare(attr.value)
+            end
+
+            node.children.each do |child|
+              result = xml_node_to_hash(child)
+              if child.is_a? Nokogiri::XML::Text
+                unless child.next_sibling || child.previous_sibling
+                  return prepare(result)
+                end
+              elsif result_hash[child_name = child.namespaced_name]
+                result_hash[child_name] = [result_hash[child_name]] unless result_hash[child_name].is_a?(Object::Array)
+                result_hash[child_name] << prepare(result)
+              else
+                result_hash[child_name] = prepare(result)
+              end
+            end
+
+            result_hash
+          else
+            prepare(node.content.to_s)
+          end
+        end
+
+        def prepare(data)
+          if data.is_a?(String) && data.to_i.to_s == data
+            data.to_i
+          elsif data == {}
+            ''
+          else
+            data
+          end
+        end
+      end
+
+      included do
+        class_attribute :_attr_aliases
+        self.format = Format.new
+      end
+
+      module ClassMethods
+        def attr_aliases(aliases)
+          self._attr_aliases = aliases
+          aliases.each do |new_attr, original_attr|
+            define_method(new_attr) {|*args| send(original_attr, *args) }
+            define_method("#{new_attr}=") {|*args| send("#{original_attr}=", *args) }
+          end
+        end
+      end
+
+      def aliased_attributes
+        aliased = _attr_aliases.invert
+        gsx_attributes = self.attributes.keys.map do |attr|
+          if matches = attr.match(/^(gsx:)/)
+            (aliased[matches.post_match] || matches.post_match).to_s
+          else
+            nil
+          end
+        end.compact
+        (self.class.known_attributes + gsx_attributes).uniq
+      end
+
+      def respond_to?(method, include_priv = false)
+        method_name = method.to_s
+        ((matches = method_name.match(/(=|\?)$/)) && attributes.include?("gsx:#{matches.pre_match}")) ||
+        attributes.include?("gsx:#{method_name}") ||
+        super
+      end
+
+      def method_missing(method_symbol, *arguments)
+        method_name = method_symbol.to_s
+
+        if (matches = method_name.match(/(=)$/)) && attributes.include?("gsx:#{matches.pre_match}")
+          attributes["gsx:#{matches.pre_match}"] = arguments.first
+        elsif (matches = method_name.match(/(\?)$/)) && attributes.include?("gsx:#{matches.pre_match}")
+          attributes["gsx:#{matches.pre_match}"]
+        elsif attributes.include?("gsx:#{method_name}")
+          attributes["gsx:#{method_name}"]
+        else
+          super
+        end
+      end
+    end
+  end
+end
+
+class Nokogiri::XML::Node
+  def namespaced_name
+    (namespace.try(:prefix).present? ? "#{namespace.prefix}:" : '') + name
+  end
+end

data/lib/google_spreadsheets/enhanced/row.rb

@@ -0,0 +1,11 @@
+module GoogleSpreadsheets
+  module Enhanced
+    class Row < GoogleSpreadsheets::List
+      include GoogleSpreadsheets::LinkRelations
+      include NamespacePreservable
+
+      self.collection_parser = Collection
+      self.primary_key = :'gsx:id'
+    end
+  end
+end

data/lib/google_spreadsheets/enhanced/spreadsheet.rb

@@ -0,0 +1,11 @@
+module GoogleSpreadsheets
+  module Enhanced
+    class Spreadsheet < GoogleSpreadsheets::Spreadsheet
+      include GoogleSpreadsheets::LinkRelations
+      include NamespacePreservable
+
+      links_to_many :worksheets, rel: 'http://schemas.google.com/spreadsheets/2006#worksheetsfeed'
+      self.collection_parser = Collection
+    end
+  end
+end

data/lib/google_spreadsheets/enhanced/synchronizer.rb

@@ -0,0 +1,54 @@
+module GoogleSpreadsheets
+  module Enhanced
+    module Synchronizer
+
+      # === Example
+      # class User < ActiveRecord::Base
+      #   extend GoogleSpreadsheets::Enhanced::Synchronizer
+      #   sync_with :user_rows, spreadsheet_id: 'xxxx',
+      #                         worksheet_title: 'users'
+      #   after_commit :sync_user_row
+      def sync_with(rows_name, options)
+        options.assert_valid_keys(:spreadsheet_id, :worksheet_title, :class_name)
+        options[:worksheet_title] ||= rows_name.to_s
+        spreadsheet_class_name = LinkRelations.class_name_mappings['http://schemas.google.com/spreadsheets/2006#spreadsheet'].classify
+        define_singleton_method(rows_name) do
+          @worksheet ||= spreadsheet_class_name.constantize
+                           .find(options[:spreadsheet_id])
+                           .worksheets
+                           .find_by!(title: options[:worksheet_title])
+          @worksheet.rows
+        end
+
+        # import all
+        define_singleton_method("sync_with_#{rows_name}") do
+          rows = send(rows_name)
+          rows.each do |row|
+            record = self.find_or_initialize_by(id: row.id)
+            row.aliased_attributes.each do |attr|
+              record.send("#{attr}=", row.send(attr))
+            end
+            record.instance_variable_set(:@_skip_outbound_sync, true)
+            record.save
+            record.remove_instance_variable(:@_skip_outbound_sync)
+          end
+        end
+
+        # export one
+        define_method("sync_#{rows_name.to_s.singularize}") do
+          return if @_skip_outbound_sync
+          row = self.class.send(rows_name).find(self.id)
+          if destroyed?
+            row.destroy
+          else
+            # TODO: separate by AttributeAssignment
+            self.attributes_before_type_cast.each do |attr, value|
+              row.send("#{attr}=", value)
+            end
+            row.save
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google_spreadsheets/enhanced/worksheet.rb

@@ -0,0 +1,11 @@
+module GoogleSpreadsheets
+  module Enhanced
+    class Worksheet < GoogleSpreadsheets::Worksheet
+      include GoogleSpreadsheets::LinkRelations
+      include NamespacePreservable
+
+      links_to_many :rows, rel: 'http://schemas.google.com/spreadsheets/2006#listfeed'
+      self.collection_parser = Collection
+    end
+  end
+end

data/lib/google_spreadsheets/link_relations.rb

@@ -0,0 +1,77 @@
+module GoogleSpreadsheets
+  module LinkRelations
+    extend ActiveSupport::Concern
+
+    class << self
+      DEFAULT_CLASS_NAME_MAPPINGS = {
+        'http://schemas.google.com/spreadsheets/2006#spreadsheet'    => 'GoogleSpreadsheets::Enhanced::Spreadsheet',
+        'http://schemas.google.com/spreadsheets/2006#worksheetsfeed' => 'GoogleSpreadsheets::Enhanced::Worksheet',
+        'http://schemas.google.com/spreadsheets/2006#listfeed'       => 'GoogleSpreadsheets::Enhanced::Row'
+      }
+      def class_name_mappings
+        @class_name_mappings ||= DEFAULT_CLASS_NAME_MAPPINGS
+      end
+      attr_writer :class_name_mappings
+    end
+
+    module Builder
+      class LinksToMany < ActiveResource::Associations::Builder::Association
+        self.macro = :links_to_many
+        self.valid_options = [:class_name, :rel]
+
+        def build
+          validate_options
+          model.create_reflection(self.class.macro, name, options).tap do |reflection|
+            model.defines_links_to_many_finder_method(reflection.name, reflection.options[:rel], reflection.klass)
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      def links_to_many(name, options = {})
+        Builder::LinksToMany.build(self, name, options)
+      end
+
+      def defines_links_to_many_finder_method(method_name, relation_name, association_model)
+        ivar_name = :"@#{method_name}"
+
+        define_method(method_name) do
+          if instance_variable_defined?(ivar_name)
+            instance_variable_get(ivar_name)
+          elsif attributes.include?(method_name)
+            attributes[method_name]
+          else
+            link = self.link.find{|l| l.rel ==  relation_name }
+            path = link.href.slice(%r|^https://spreadsheets\.google\.com(/.*)|, 1)
+            instance_variable_set(ivar_name, association_model.find(:all, from: path))
+          end
+        end
+      end
+
+      def create_reflection(macro, name, options)
+        # TODO: improve
+        if macro == :links_to_many
+          reflection = LinkRelationReflection.new(macro, name, options)
+          self.reflections = self.reflections.merge(name => reflection)
+          reflection
+        else
+          super
+        end
+      end
+    end
+
+    class LinkRelationReflection < ActiveResource::Reflection::AssociationReflection
+      private
+      def derive_class_name
+        if options[:class_name]
+          options[:class_name].to_s
+        elsif options[:rel]
+          GoogleSpreadsheets::LinkRelations.class_name_mappings.fetch(options[:rel])
+        else
+          name.to_s
+        end.classify
+      end
+    end
+  end
+end

data/lib/google_spreadsheets/version.rb

@@ -1,3 +1,3 @@
 module GoogleSpreadsheets
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activeresource-google_spreadsheets
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Chihiro Ito
@@ -9,62 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-26 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Google Spreadsheets accessor with ActiveResource
@@ -74,7 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,7 +84,15 @@ files:
 - lib/google_spreadsheets.rb
 - lib/google_spreadsheets/base.rb
 - lib/google_spreadsheets/connection.rb
+- lib/google_spreadsheets/enhanced.rb
+- lib/google_spreadsheets/enhanced/collection.rb
+- lib/google_spreadsheets/enhanced/namespace_preservable.rb
+- lib/google_spreadsheets/enhanced/row.rb
+- lib/google_spreadsheets/enhanced/spreadsheet.rb
+- lib/google_spreadsheets/enhanced/synchronizer.rb
+- lib/google_spreadsheets/enhanced/worksheet.rb
 - lib/google_spreadsheets/g_data_format.rb
+- lib/google_spreadsheets/link_relations.rb
 - lib/google_spreadsheets/list.rb
 - lib/google_spreadsheets/spreadsheet.rb
 - lib/google_spreadsheets/version.rb
@@ -99,17 +107,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Google Spreadsheets accessor with ActiveResource