opium 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af0eabf84dc2725b37a028ab361dace64cf64b77
-  data.tar.gz: e3220606ae49fdb2322b2a008b36a44eb47d8131
+  metadata.gz: 20938c9338f0dea54366b7ae20a74a5e416c1b3e
+  data.tar.gz: 901e5c2f20e9db92da93f2e32fd0c64bc6323269
 SHA512:
-  metadata.gz: c79a1131fbe18550a72aa80a425b040f39423e4cfa3c57097dc95bd64883f30632a1e549fdfece5f26c64f8a338d6cc9e1f8ae6501b49cd902c5e40990520626
-  data.tar.gz: d98dc79d4d4919202d4374908b9b57a4c9fd5ec1444c555223a06520fea777de6efee82ce650257b434b4aed8eb9cf7f6bae46399f1fd2dfff3b0f0794599a19
+  metadata.gz: 812b467de4ac66ffedd6b3bf7be8965b09af23a3a9bd8253dfac3ecf4cc7dc1608458bb27e3f116142ef77d220f83c3b4b6d1d4d11230859c0fbef1d9021a89f
+  data.tar.gz: f5f78274f8963237dee6db4dd81d27e383d3440a550f7a5105e0ae2ce3769ec5b71d13149d79d6ffe56839dac0c727061d872ec695ac289ae299539f773d0811

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.2.4
+### Resolved Issues
+- #49: Opium::File#to_ruby now correctly handles blank/empty strings.
+
 ## 1.2.3
 ### New Features
 - Config file can now track the Parse API webhook key.

data/lib/opium/file.rb

@@ -21,7 +21,7 @@ module Opium
       end
       
       def to_ruby( object )
-        return unless object
+        return if object.nil? || object == ''
         return object if object.is_a?( self )
         object = ::JSON.parse( object ) if object.is_a?( String )
         if object.is_a?( Hash ) && (has_key_of_value( object, :__type, 'File' ) || has_keys( object, :url, :name ))

data/lib/opium/model/connectable.rb

@@ -5,19 +5,19 @@ module Opium
   module Model
     module Connectable
       extend ActiveSupport::Concern
-      
+
       included do
       end
-      
+
       class ParseError < StandardError
         def initialize( code, error )
           super( error )
           @code = code
         end
-        
+
         attr_reader :code
       end
-      
+
       module ClassMethods
         def connection
           @@connection ||= Faraday.new( url: 'https://api.parse.com/1/' ) do |faraday|
@@ -30,20 +30,20 @@ module Opium
             faraday.adapter Faraday.default_adapter
           end
         end
-        
+
         def reset_connection!
           @@connection = nil
         end
-        
+
         def object_prefix
           @object_prefix ||= 'classes'
         end
-        
+
         # Parse doesn't route User objects through /classes/, instead treating them as a top-level class.
         def no_object_prefix!
           @object_prefix = ''
         end
-        
+
         def as_resource( name, &block )
           fail ArgumentError, 'no block given' unless block_given?
           @masked_resource_name = name.to_s.freeze
@@ -51,13 +51,13 @@ module Opium
         ensure
           @masked_resource_name = nil
         end
-        
+
         def resource_name( resource_id = nil )
           return @masked_resource_name if @masked_resource_name
           @resource_name ||= Pathname.new( object_prefix ).join( map_name_to_resource( model_name ) )
           ( resource_id ? @resource_name.join( resource_id ) : @resource_name ).to_s
         end
-        
+
         def http_get( options = {} )
           http( :get, options ) do |request|
             options.fetch(:query, {}).each do |key, value|
@@ -65,38 +65,42 @@ module Opium
             end
           end
         end
-        
+
         def http_post( data, options = {} )
           http( :post, deeply_merge( options, content_type_json ), &infuse_request_with( data ) )
         end
-        
+
         def http_put( id, data, options = {} )
-          http( :put, deeply_merge( options, content_type_json, id: id ), &infuse_request_with( data ) )          
+          http( :put, deeply_merge( options, content_type_json, id: id ), &infuse_request_with( data ) )
         end
-        
+
         def http_delete( id, options = {} )
           http( :delete, deeply_merge( options, id: id ) )
         end
-        
+
         def requires_heightened_privileges!
           @requires_heightened_privileges = true
         end
-        
+
         def requires_heightened_privileges?
           !@requires_heightened_privileges.nil?
         end
-        
+
         alias_method :has_heightened_privileges?, :requires_heightened_privileges?
-        
+
         def with_heightened_privileges(&block)
           previous, @requires_heightened_privileges = @requires_heightened_privileges, true
           block.call if block_given?
         ensure
           @requires_heightened_privileges = previous
         end
-        
+
+        def no_really_i_need_master!
+          @always_heightened_privileges = true
+        end
+
         private
-                
+
         def http( method, options, &block )
           check_for_error( options ) do
             if options[:sent_headers]
@@ -109,43 +113,46 @@ module Opium
             end
           end
         end
-        
+
         def deeply_merge( *args )
           args.reduce {|a, e| a.deep_merge e }
         end
-        
+
         def content_type_json
           @content_type_json ||= { headers: { content_type: 'application/json' } }
         end
-        
+
         def map_name_to_resource( model_name )
           name = model_name.name.demodulize
           @object_prefix.empty? ? name.tableize : name
         end
-        
+
         def infuse_request_with( data )
           lambda do |request|
             request.body = data
           end
         end
-        
+
         def apply_headers_to_request( method, options, &further_operations )
           lambda do |request|
             request.headers.update options[:headers] if options[:headers]
 
-            added_master_key = 
-              unless request.headers[:x_parse_session_token]
-                if method != :get && requires_heightened_privileges? && Opium.config.master_key
-                  request.headers[:x_parse_master_key] = Opium.config.master_key
-                end
-              end
-            
-            request.headers[:x_parse_rest_api_key] = Opium.config.api_key unless added_master_key
-            
+            if use_master_key?( request, method )
+              request.headers[:x_parse_master_key] = Opium.config.master_key
+            else
+              request.headers[:x_parse_rest_api_key] = Opium.config.api_key
+            end
+
             further_operations.call( request ) if block_given?
           end
         end
-        
+
+        def use_master_key?( request, method )
+          !request.headers[:x_parse_session_token] &&
+          ( @always_heightened_privileges || method != :get ) &&
+            requires_heightened_privileges? && Opium.config.master_key
+        end
+
         def check_for_error( options = {}, &block )
           fail ArgumentError, 'no block given' unless block_given?
           result = yield
@@ -161,4 +168,4 @@ module Opium
       end
     end
   end
-end
+end

data/lib/opium/model/field.rb

@@ -4,9 +4,9 @@ module Opium
       def initialize(name, type, default, readonly, as)
         self.name, self.type, self.default, self.readonly, self.as = name, type, default, readonly, as
       end
-      
+
       attr_reader :name, :type, :readonly, :as
-      
+
       def default( context = nil )
         if @default.respond_to? :call
           params = []
@@ -16,30 +16,34 @@ module Opium
           @default
         end
       end
-      
+
       def contextual_default_value( context = nil)
         type.to_ruby( default( context ) )
       end
-      
+
       def readonly?
         self.readonly == true
       end
-      
+
       def relation?
         self.type == Relation
       end
-      
+
       def virtual?
         relation? || self.type == Reference
       end
-      
+
       def name_to_parse
         @name_to_parse ||= (self.as || self.name).to_s.camelize(:lower)
       end
-      
+
+      def name_to_ruby
+        @name_to_ruby ||= (self.as || self.name).to_s.underscore
+      end
+
       private
-      
+
       attr_writer :name, :type, :default, :readonly, :as
     end
   end
-end
+end

data/lib/opium/model/fieldable.rb

@@ -4,13 +4,13 @@ module Opium
   module Model
     module Fieldable
       extend ActiveSupport::Concern
-      
+
       included do
         field :id, type: String, readonly: true, as: :object_id
         field :created_at, type: DateTime, readonly: true
         field :updated_at, type: DateTime, readonly: true
       end
-      
+
       module ClassMethods
         def field( name, options = {} )
           create_field_from( name.to_sym, options ).tap do |field|
@@ -18,38 +18,38 @@ module Opium
             create_field_setter_for( field )
           end
         end
-        
+
         def has_field?( field_name )
           fields.key? field_name
         end
-        
+
         alias_method :field?, :has_field?
-        
+
         def fields
           @fields ||= {}.with_indifferent_access
         end
-        
+
         def ruby_canonical_field_names
           @ruby_canonical_field_names ||= {}.with_indifferent_access
         end
-        
+
         def parse_canonical_field_names
           @parse_canonical_field_names ||= {}.with_indifferent_access
         end
-        
+
         def default_attributes( context = nil )
           fields.transform_values {|field| field.contextual_default_value( context ) }.with_indifferent_access
         end
-        
+
         private
-        
+
         def create_field_from( name, options )
           field = Field.new( name, options[:type] || Object, options[:default], options[:readonly] || false, options[:as] )
           ruby_canonical_field_names[name] = ruby_canonical_field_names[field.name_to_parse] = name.to_s
           parse_canonical_field_names[name] = parse_canonical_field_names[field.name_to_parse] = field.name_to_parse.to_s
           fields[name] = field
         end
-        
+
         def create_field_getter_for( field )
           class_eval do
             define_attribute_methods [field.name]
@@ -58,7 +58,7 @@ module Opium
             end
           end
         end
-        
+
         def create_field_setter_for( field )
           class_eval do
             define_method("#{ field.name }=") do |value|
@@ -66,7 +66,7 @@ module Opium
               send( "#{ field.name }_will_change!" ) unless self.attributes[field.name] == converted
               if field.relation?
                 converted = field.contextual_default_value( self ) unless converted
-                converted.owner ||= self 
+                converted.owner ||= self
                 converted.metadata ||= self.class.relations[field.name]
               end
               self.attributes[field.name] = converted
@@ -77,4 +77,4 @@ module Opium
       end
     end
   end
-end
+end

data/lib/opium/model.rb

@@ -3,6 +3,7 @@ require 'active_support/core_ext/string'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/hash/deep_merge'
 require 'active_support/core_ext/hash/transform_values'
+require 'active_support/core_ext/enumerable'
 require 'active_support/inflector'
 require 'opium/model/connectable'
 require 'opium/model/persistable'
@@ -23,9 +24,9 @@ require 'opium/model/kaminari'
 module Opium
   module Model
     extend ActiveSupport::Concern
-        
+
     include ActiveModel::Model
-    
+
     included do
       include Connectable
       include Persistable
@@ -42,14 +43,14 @@ module Opium
       include Relatable
       include GlobalID::Identification if defined?( GlobalID )
     end
-    
+
     def initialize( attributes = {} )
       self.attributes = attributes
     end
-        
+
     def inspect
       inspected_fields = self.attributes.map {|k, v| [k, v.inspect].join(': ')}.join(', ')
       "#<#{self.class.model_name} #{inspected_fields}>"
     end
   end
-end
+end

data/lib/opium/schema.rb

@@ -0,0 +1,48 @@
+module Opium
+  class Schema
+    include Opium::Model::Connectable
+
+    requires_heightened_privileges!
+    no_really_i_need_master!
+    no_object_prefix!
+
+    class << self
+      def all
+        http_get[:results].map {|schema| new( schema ) }.index_by(&:class_name)
+      end
+
+      def find( model_name, options = {} )
+        result = http_get( options.merge id: model_name )
+        options[:sent_headers] ? result : new( result )
+      end
+
+      def model_name
+        @model_name ||= ActiveModel::Name.new( self, nil, self.name )
+      end
+    end
+
+
+    attr_reader :class_name, :fields
+
+    def initialize( attributes = {} )
+      attributes.deep_symbolize_keys.tap do |a|
+        @class_name = a[:className]
+        @fields = ( a[:fields] || {} ).map do |field_name, options|
+          Opium::Model::Field.new( field_name, options[:type], nil, false, nil )
+        end.index_by(&:name_to_ruby)
+      end
+    end
+
+    def save
+
+    end
+
+    def delete
+
+    end
+
+    def model
+
+    end
+  end
+end

data/lib/opium/version.rb

@@ -1,3 +1,3 @@
 module Opium
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

data/lib/opium.rb

@@ -7,4 +7,5 @@ require 'opium/extensions'
 require 'opium/model'
 require 'opium/user'
 require 'opium/file'
-require 'opium/railtie' if defined?( Rails )
+require 'opium/schema'
+require 'opium/railtie' if defined?( Rails )

data/spec/opium/file_spec.rb

@@ -132,6 +132,13 @@ describe Opium::File do
       it { expect( result ).to be_a Opium::File }
     end
     
+    context 'when given an empty string' do
+      let(:object) { '' }
+      
+      it { expect { result }.to_not raise_exception }
+      it { expect( result ).to be_nil }
+    end
+    
     context 'when not given a hash' do
       let(:object) { 42 }
       

data/spec/opium/schema_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper.rb'
+
+describe Opium::Schema do
+  before do
+    stub_const( 'Game', Class.new do |klass|
+      include Opium::Model
+      field :name, type: String
+      field :current_price, type: Float
+    end )
+    stub_const( 'Player', Class.new do |klass|
+      include Opium::Model
+      field :player_tag, type: String
+      field :player_score, type: Integer
+    end )
+  end
+
+  let(:game_schema) do
+    {
+      className: 'Game',
+      fields: {
+        objectId: { type: 'String' },
+        name: { type: 'String' },
+        current_price: { type: 'Number' },
+        createdAt: { type: 'Date' },
+        updatedAt: { type: 'Date' }
+      }
+    }
+  end
+
+  let(:player_schema) do
+    {
+      className: 'Player',
+      fields: {
+        objectId: { type: 'String' },
+        player_tag: { type: 'String' },
+        player_score: { type: 'Number' },
+        createdAt: { type: 'Date' },
+        updatedAt: { type: 'Date' }
+      }
+    }
+  end
+
+  it { expect( described_class ).to respond_to( :connection, :http_get ) }
+  it { expect( described_class ).to have_heightened_privileges }
+  it { expect( described_class.object_prefix ).to be_blank }
+
+  it { expect( described_class ).to respond_to( :find ).with( 1 ).argument }
+  it { expect( described_class ).to respond_to( :all ) }
+  it { is_expected.to respond_to( :save, :delete, :model, :fields, :class_name ) }
+
+  describe '.find' do
+    let(:result) { described_class.find( model_name, options ) }
+    let(:options) { {} }
+
+    context 'with a sent_headers option' do
+      let(:model_name) { 'NoOp' }
+      let(:options) { { sent_headers: true } }
+
+      it { expect { result }.to_not raise_exception }
+      it { expect( result.keys ).to include('X-Parse-Master-Key') }
+      it { expect( result.keys ).to_not include('X-Parse-Rest-Api-Key') }
+    end
+
+    context 'with a valid model name' do
+      let(:model_name) { 'Game' }
+
+      before do
+        stub_request(:get, "https://api.parse.com/1/schemas/Game").
+          with(headers: {'X-Parse-Application-Id'=>'PARSE_APP_ID', 'X-Parse-Master-Key'=>'PARSE_MASTER_KEY'}).
+          to_return(status: 200, body: game_schema.to_json, headers: { content_type: 'application/json' })
+      end
+
+      it { expect { result }.to_not raise_exception }
+      it { expect( result ).to be_a( Opium::Schema ) }
+      it('sets the correct model name from the results') { expect( result.class_name ).to eq 'Game' }
+      it { expect( result.fields ).to be_a Hash }
+      it { expect( result.fields.values ).to all( be_a Opium::Model::Field ) }
+    end
+
+    context 'with an invalid model name' do
+      let(:model_name) { 'DoesNotExist' }
+
+      before do
+        stub_request(:get, "https://api.parse.com/1/schemas/DoesNotExist").
+          with(headers: {'X-Parse-Application-Id'=>'PARSE_APP_ID', 'X-Parse-Master-Key'=>'PARSE_MASTER_KEY'}).
+          to_return(status: 400, body: {
+            code: 103, error: 'class DoesNotExist does not exist'
+          }.to_json, headers: { content_type: 'application/json' })
+      end
+
+      it { expect { result }.to raise_exception( Opium::Model::Connectable::ParseError ) }
+    end
+  end
+
+  describe '.all' do
+    let(:result) { described_class.all }
+
+    context 'when there are no classes' do
+      before do
+        stub_request(:get, "https://api.parse.com/1/schemas").
+          with(headers: {'X-Parse-Application-Id'=>'PARSE_APP_ID', 'X-Parse-Master-Key'=>'PARSE_MASTER_KEY'}).
+          to_return(status: 200, body: {
+            results: []
+          }.to_json, headers: { content_type: 'application/json' })
+      end
+
+      it { expect( result ).to be_empty }
+      it { expect( result ).to be_a( Hash ) }
+    end
+
+    context 'when there are multiple classes' do
+      before do
+        stub_request(:get, "https://api.parse.com/1/schemas").
+          with(headers: {'X-Parse-Application-Id'=>'PARSE_APP_ID', 'X-Parse-Master-Key'=>'PARSE_MASTER_KEY'}).
+          to_return(status: 200, body: {
+            results: [
+              game_schema,
+              player_schema
+            ]
+          }.to_json, headers: { content_type: 'application/json' })
+      end
+
+      let(:expected_keys) { [ 'Game', 'Player' ] }
+
+      it { expect( result ).to_not be_empty }
+      it { expect( result.keys ).to include( *expected_keys ) }
+      it { expect( result.values ).to all( be_a( Opium::Schema ) ) }
+    end
+  end
+
+  describe '#save' do
+
+  end
+
+  describe '#delete' do
+
+  end
+
+  describe '#fields' do
+
+  end
+end

data/spec/opium_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
 
 describe Opium do
-  it { expect( described_class.constants ).to include( :Model, :User, :File, :Config ) }
-end
+  it { expect( described_class.constants ).to include( :Model, :User, :File, :Config, :Schema ) }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opium
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Joshua Bowers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-29 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -302,6 +302,7 @@ files:
 - lib/opium/model/scopable.rb
 - lib/opium/model/serialization.rb
 - lib/opium/railtie.rb
+- lib/opium/schema.rb
 - lib/opium/user.rb
 - lib/opium/version.rb
 - opium.gemspec
@@ -345,6 +346,7 @@ files:
 - spec/opium/model/scopable_spec.rb
 - spec/opium/model/serialization_spec.rb
 - spec/opium/model_spec.rb
+- spec/opium/schema_spec.rb
 - spec/opium/user_spec.rb
 - spec/opium_spec.rb
 - spec/spec_helper.rb
@@ -368,7 +370,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: An Object Parse.com Mapping technology for defining models.
@@ -413,6 +415,7 @@ test_files:
 - spec/opium/model/scopable_spec.rb
 - spec/opium/model/serialization_spec.rb
 - spec/opium/model_spec.rb
+- spec/opium/schema_spec.rb
 - spec/opium/user_spec.rb
 - spec/opium_spec.rb
 - spec/spec_helper.rb