parse-model-scaffold 0.1.1 → 0.11.0

data/README.md

@@ -1,12 +1,14 @@
 parse-model-scaffold
 ====================
 
-This project is a work in progress!
+*This project is a work in progress!*
+
+This project aims to provide a simple way to create concrete subclasses of your Parse.com 'classes' in a variety of languages.  This could be used as part of a CI process to keep Parse.com and your codebase in sync or simply as a way to boostrap Parse.com integration in a new environment.  Where possible, the code this project generates will extend the PFObject representation in the Parse.com SDK for the given language.
 
 The following languages are currently supported.  If you don't see your preferred language, pull requests are welcome!  PFScaffolder will generate all languages by default.
 
-* Coffee-script ```:coffee```
-* Objective-C ```:objc```
+* Coffee-script ```:coffee``` - https://parse.com/docs/js/symbols/Parse.Object.html
+* Objective-C ```:objc``` - https://parse.com/docs/ios/api/Classes/PFObject.html
 
 Usage
 =====

data/Rakefile

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

data/lib/parse-model-scaffold/parse_api.rb

@@ -8,13 +8,15 @@ module Parse
               include HTTParty
               base_uri 'https://api.parse.com/1/classes'
 
+              attr_accessor :options
+
               def initialize(appId, apiKey)
                 headers = {'X-Parse-Application-Id' => appId, 'X-Parse-REST-API-Key' => apiKey}
-                @options = {:headers => headers}
+                self.options = {:headers => headers}
               end
 
               def get_first(class_name)
-                response = self.class.get("/#{class_name}", @options.merge({:query => {:limit => 1}}))
+                response = self.class.get("/#{class_name}", options.merge({:query => {:limit => 1}}))
 
                 response['results'][0]
               end

data/lib/parse-model-scaffold/parse_class_builder.rb

@@ -37,8 +37,6 @@ module Parse
                             # Remove extenstion, and name propertly
                             tmpl_file.gsub!('template', @class_name).gsub!(File.extname(tmpl_file), '')
 
-
-
                             File.open(tmpl_file, 'w') { |file| file.write(output) }
                         end
                     end

data/lib/parse-model-scaffold/parse_inspector.rb

@@ -1,26 +1,22 @@
+require 'parse-model-scaffold/types'
+
 module Parse
     module Model
         module Scaffold
             
-            class ParseInspector
+            PROTECTED_FIELDS = ['objectId', 'createdAt', 'updatedAt', 'ACL']
 
-                Attribute = Struct.new :name, :type do
-                    def to_s
-                        self.name
-                    end
-                end
-
-                @@protected_fields = ['objectId', 'createdAt', 'updatedAt', 'ACL']
+            class ParseInspector
 
                 def self.parse(obj)
 
-                    @@protected_fields.each {|x| obj.delete x}
+                    PROTECTED_FIELDS.each {|x| obj.delete x}
 
                     attrs = []
 
                     obj.each do |k, v|
                         value_type = determine_type(v)
-                        attr = Attribute.new(k, value_type)
+                        attr = ParseAttribute.new(k, value_type)
                         attrs << attr
                     end
 
@@ -30,13 +26,12 @@ module Parse
                 # Map Parse types to Ruby types if possible, otherwise, leave them as a 
                 def self.determine_type(val)
 
-                    return val.class.to_s.to_sym if [String, Array].include? val.class
-
+                    # Parse represents complex types as a JSON object, so we need to inspect it
                     if val.is_a? Hash
 
                         # If we don't see the Parse '__type' key that they use for encoding
                         # complex types, then this is just a simple object
-                        return Hash if !val.has_key? '__type'
+                        return :Hash if !val.has_key? '__type'
 
                         # Otherwise, this is probably a Parse type (Relation, Pointer, GeoPoint, etc.)
                         return val['__type'].to_sym
@@ -44,7 +39,7 @@ module Parse
 
                     return :Boolean if [TrueClass, FalseClass].include? val.class
 
-                    # Last resort
+                    # Base case
                     val.class.to_s.to_sym
                 end
             end

data/lib/parse-model-scaffold/types.rb

@@ -0,0 +1,11 @@
+ParseClass = Struct.new :name, :attributes do
+    def to_s
+        self.name
+    end
+end
+
+ParseAttribute = Struct.new :name, :type do
+    def to_s
+        self.name
+    end
+end

data/lib/parse-model-scaffold/version.rb

@@ -1,7 +1,7 @@
 module Parse
 	module Model
 		module Scaffold
-			VERSION = "0.1.1"
+			VERSION = "0.11.0"
 		end
 	end
 end

data/parse-model-scaffold.gemspec

@@ -19,4 +19,8 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'httparty'
   gem.add_runtime_dependency 'slop'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
 end

data/spec/parse_api_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'json'
+
+describe Parse::Model::Scaffold::ParseApi do
+
+    subject { Parse::Model::Scaffold::ParseApi.new 'my_app_id', 'my_api_key' }
+
+    it 'should exist after creation' do
+        subject.should_not be_nil
+    end
+
+    it 'should use custom http headers' do
+        subject.options.has_key?(:headers).should be_true
+    end
+
+    it 'should use app_id as an HTTP header' do
+        subject.options[:headers].has_key?('X-Parse-Application-Id').should be_true
+        subject.options[:headers]['X-Parse-Application-Id'].should eql('my_app_id')
+    end
+
+    it 'should use api_key as an HTTP header' do
+        subject.options[:headers].has_key?('X-Parse-REST-API-Key').should be_true
+        subject.options[:headers]['X-Parse-REST-API-Key'].should eql('my_api_key')
+    end
+
+    it 'should return a single object from get_first' do
+
+        stub_request(:get, "https://api.parse.com/1/classes/testclass?limit=1")
+            .to_return(
+                :body => JSON.generate(
+                    { :results => [{:name => 'mr. ding'}] }
+                ),
+                :headers => {'Content-Type' => 'application/json'}
+            )
+
+        obj = subject.get_first 'testclass'
+
+        obj.nil?.should be_false
+        obj.has_key?('name').should be_true
+        obj['name'].should eql('mr. ding')
+    end
+end

data/spec/parse_inspector_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe Parse::Model::Scaffold::ParseInspector do
+
+	it 'should ignore protected Parse fields' do
+
+		obj = {
+			'ACL' => {},
+			'createdAt' => {},
+			'updatedAt' => {},
+			'objectId' => {}
+		}
+
+		attrs = Parse::Model::Scaffold::ParseInspector.parse(obj)
+
+		attrs.length.should equal(0)
+	end
+
+	describe 'parsing native ruby types' do
+
+		it 'should identify strings' do
+
+			obj = { 'name' => 'testname'}
+
+			attrs = Parse::Model::Scaffold::ParseInspector.parse(obj)
+
+			attrs.length.should equal(1)
+			attrs[0].type.should eql(:String)
+		end
+
+		it 'should identify booleans' do
+
+			obj = { 'active' => false}
+
+			attrs = Parse::Model::Scaffold::ParseInspector.parse(obj)
+
+			attrs.length.should equal(1)
+			attrs[0].type.should eql(:Boolean)
+		end
+
+		it 'should identify numbers' do
+
+			obj = { 'age' => 23}
+
+			attrs = Parse::Model::Scaffold::ParseInspector.parse(obj)
+
+			attrs.length.should equal(1)
+			attrs[0].type.should eql(:Fixnum)
+		end
+
+		it 'should identify arrays' do
+
+			obj = { 'favorites' => [1,2,3]}
+
+			attrs = Parse::Model::Scaffold::ParseInspector.parse(obj)
+
+			attrs.length.should equal(1)
+			attrs[0].type.should eql(:Array)
+		end
+
+		it 'should identify objects' do
+
+			obj = { 'attributes' => {}}
+
+			attrs = Parse::Model::Scaffold::ParseInspector.parse(obj)
+
+			attrs.length.should equal(1)
+			attrs[0].type.should eql(:Hash)
+		end
+	end
+
+	describe 'parsing Parse attribute types' do
+
+		it 'should identify PFObject pointers' do
+			obj = {
+				"photo" => {
+			        "__type" => "Pointer",
+			        "className" => "Photo",
+			        "objectId" => "xxxxxxxx"
+			    }
+			}
+
+			attrs = Parse::Model::Scaffold::ParseInspector.parse(obj)
+
+			attrs.length.should equal(1)
+			attrs[0].type.should eql(:Pointer)
+		end
+
+		it 'should identify PFRelations' do
+			obj = {
+				"categories" => {
+			        "__type" => "Relation",
+			        "className" => "Category"
+			    }
+			}
+
+			attrs = Parse::Model::Scaffold::ParseInspector.parse(obj)
+
+			attrs.length.should equal(1)
+			attrs[0].type.should eql(:Relation)
+		end
+
+		it 'should identify PFGeoPoints' do
+			obj = {
+				"categories" => {
+			        "__type" => "GeoPoint",
+			        "latitude" => 38.80523194147864,
+        			"longitude" => -77.04765558242798
+			    }
+			}
+
+			attrs = Parse::Model::Scaffold::ParseInspector.parse(obj)
+
+			attrs.length.should equal(1)
+			attrs[0].type.should eql(:GeoPoint)
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'parse-model-scaffold'
+require 'webmock/rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parse-model-scaffold
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -43,6 +43,54 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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'
 description: Tool to generate concrete subclasses of existing Parse.com model objects
   in a variety of languages.
 email:
@@ -54,7 +102,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -66,8 +113,12 @@ files:
 - lib/parse-model-scaffold/templates/coffee/template.coffee.ejs
 - lib/parse-model-scaffold/templates/objc/template.h.ejs
 - lib/parse-model-scaffold/templates/objc/template.m.ejs
+- lib/parse-model-scaffold/types.rb
 - lib/parse-model-scaffold/version.rb
 - parse-model-scaffold.gemspec
+- spec/parse_api_spec.rb
+- spec/parse_inspector_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/mhupman/parse-model-scaffold
 licenses: []
 post_install_message: 
@@ -80,16 +131,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3005338959257829923
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3005338959257829923
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Can be included as a library or exectued as a binary.
-test_files: []
+test_files:
+- spec/parse_api_spec.rb
+- spec/parse_inspector_spec.rb
+- spec/spec_helper.rb