pingpp 2.0.15 → 2.1.0

data/lib/pingpp/pingpp_object.rb

@@ -2,25 +2,17 @@ module Pingpp
   class PingppObject
     include Enumerable
 
-    attr_accessor :api_key
-    @@permanent_attributes = Set.new([:api_key, :id])
+    @@permanent_attributes = Set.new([:id])
 
     # The default :id method is deprecated and isn't useful to us
     if method_defined?(:id)
       undef :id
     end
 
-    def initialize(id=nil, api_key=nil)
-      # parameter overloading!
-      if id.kind_of?(Hash)
-        @retrieve_options = id.dup
-        @retrieve_options.delete(:id)
-        id = id[:id]
-      else
-        @retrieve_options = {}
-      end
-
-      @api_key = api_key
+    def initialize(id=nil, opts={})
+      id, @retrieve_params = Util.normalize_id(id)
+      @opts = Util.normalize_opts(opts)
+      @original_values = {}
       @values = {}
       # This really belongs in APIResource, but not putting it there allows us
       # to have a unified inspect method
@@ -29,8 +21,13 @@ module Pingpp
       @values[:id] = id if id
     end
 
-    def self.construct_from(values, api_key=nil)
-      self.new(values[:id], api_key).refresh_from(values, api_key)
+    def self.construct_from(values, opts={})
+      values = Pingpp::Util.symbolize_names(values)
+      self.new(values[:id]).send(:initialize_from, values, opts)
+    end
+
+    def ==(other)
+      other.is_a?(PingppObject) && @values == other.instance_variable_get(:@values)
     end
 
     def to_s(*args)
@@ -42,30 +39,11 @@ module Pingpp
       "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
     end
 
-    def refresh_from(values, api_key, partial=false)
-      @api_key = api_key
-
-      @previous_metadata = values[:metadata]
-      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
-      added = Set.new(values.keys - @values.keys)
-
-      instance_eval do
-        remove_accessors(removed)
-        add_accessors(added)
-      end
-      removed.each do |k|
-        @values.delete(k)
-        @transient_values.add(k)
-        @unsaved_values.delete(k)
-      end
-      values.each do |k, v|
-        @values[k] = Util.convert_to_pingpp_object(v, api_key)
-        @transient_values.delete(k)
-        @unsaved_values.delete(k)
-      end
-
-      return self
+    def refresh_from(values, opts, partial=false)
+      initialize_from(values, opts, partial)
     end
+    extend Gem::Deprecate
+    deprecate :refresh_from, "#initialize_from", 2017, 01
 
     def [](k)
       @values[k.to_sym]
@@ -103,12 +81,12 @@ module Pingpp
     end
 
     def _dump(level)
-      Marshal.dump([@values, @api_key])
+      Marshal.dump([@values, @opts])
     end
 
     def self._load(args)
-      values, api_key = Marshal.load(args)
-      construct_from(values, api_key)
+      values, opts = Marshal.load(args)
+      construct_from(values, opts)
     end
 
     if RUBY_VERSION < '1.9.2'
@@ -117,15 +95,37 @@ module Pingpp
       end
     end
 
+    def serialize_params(options = {})
+      update_hash = {}
+
+      @values.each do |k, v|
+        unsaved = @unsaved_values.include?(k)
+        if options[:force] || unsaved || v.is_a?(PingppObject)
+          update_hash[k.to_sym] =
+            serialize_params_value(@values[k], @original_values[k], unsaved, options[:force])
+        end
+      end
+
+      update_hash.reject! { |_, v| v == nil }
+
+      update_hash
+    end
+
     protected
 
     def metaclass
       class << self; self; end
     end
 
+    def protected_fields
+      []
+    end
+
     def remove_accessors(keys)
+      f = protected_fields
       metaclass.instance_eval do
         keys.each do |k|
+          next if f.include?(k)
           next if @@permanent_attributes.include?(k)
           k_eq = :"#{k}="
           remove_method(k) if method_defined?(k)
@@ -134,9 +134,11 @@ module Pingpp
       end
     end
 
-    def add_accessors(keys)
+    def add_accessors(keys, values)
+      f = protected_fields
       metaclass.instance_eval do
         keys.each do |k|
+          next if f.include?(k)
           next if @@permanent_attributes.include?(k)
           k_eq = :"#{k}="
           define_method(k) { @values[k] }
@@ -147,9 +149,15 @@ module Pingpp
                 "We interpret empty strings as nil in requests." +
                 "You may set #{self}.#{k} = nil to delete the property.")
             end
-            @values[k] = v
+            @values[k] = Util.convert_to_pingpp_object(v, @opts)
+            dirty_value!(@values[k])
             @unsaved_values.add(k)
           end
+
+          if [FalseClass, TrueClass].include?(values[k].class)
+            k_bool = :"#{k}?"
+            define_method(k_bool) { @values[k] }
+          end
         end
       end
     end
@@ -158,7 +166,7 @@ module Pingpp
       # TODO: only allow setting in updateable classes.
       if name.to_s.end_with?('=')
         attr = name.to_s[0...-1].to_sym
-        add_accessors([attr])
+        add_accessors([attr], {})
         begin
           mth = method(name)
         rescue NameError
@@ -183,5 +191,99 @@ module Pingpp
     def respond_to_missing?(symbol, include_private = false)
       @values && @values.has_key?(symbol) || super
     end
+
+    def update_attributes(values, opts = {}, method_options = {})
+      dirty = method_options.fetch(:dirty, true)
+      values.each do |k, v|
+        add_accessors([k], values) unless metaclass.method_defined?(k.to_sym)
+        @values[k] = Util.convert_to_pingpp_object(v, opts)
+        dirty_value!(@values[k]) if dirty
+        @unsaved_values.add(k)
+      end
+    end
+
+    def initialize_from(values, opts, partial=false)
+      @opts = Util.normalize_opts(opts)
+      @original_values = Marshal.load(Marshal.dump(values)) # deep copy
+
+      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
+      added = Set.new(values.keys - @values.keys)
+
+      instance_eval do
+        remove_accessors(removed)
+        add_accessors(added, values)
+      end
+
+      removed.each do |k|
+        @values.delete(k)
+        @transient_values.add(k)
+        @unsaved_values.delete(k)
+      end
+
+      update_attributes(values, opts, :dirty => false)
+      values.each do |k, _|
+        @transient_values.delete(k)
+        @unsaved_values.delete(k)
+      end
+
+      self
+    end
+
+    def serialize_params_value(value, original, unsaved, force)
+      case true
+      when value == nil
+        ''
+
+      when value.is_a?(APIResource) && !value.save_with_parent
+        nil
+
+      when value.is_a?(Array)
+        update = value.map { |v| serialize_params_value(v, nil, true, force) }
+
+        # This prevents an array that's unchanged from being resent.
+        if update != serialize_params_value(original, nil, true, force)
+          update
+        else
+          nil
+        end
+
+      when value.is_a?(Hash)
+        Util.convert_to_pingpp_object(value, @opts).serialize_params
+
+      when value.is_a?(PingppObject)
+        update = value.serialize_params(:force => force)
+        update = empty_values(original).merge(update) if original && unsaved
+
+        update
+
+      else
+        value
+      end
+    end
+
+    private
+
+    def dirty_value!(value)
+      case value
+      when Array
+        value.map { |v| dirty_value!(v) }
+      when PingppObject
+        value.dirty!
+      end
+    end
+
+    def empty_values(obj)
+      values = case obj
+      when Hash         then obj
+      when PingppObject then obj.instance_variable_get(:@values)
+      else
+        raise ArgumentError, "#empty_values got unexpected object type: #{obj.class.name}"
+      end
+
+      values.inject({}) do |update, (k, _)|
+        update[k] = ''
+        update
+      end
+    end
   end
 end

data/lib/pingpp/red_envelope.rb

@@ -1,9 +1,13 @@
 module Pingpp
   class RedEnvelope < APIResource
-    include Pingpp::APIOperations::List
-    include Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
 
-    def self.url
+    def self.object_name
+      'red_envelope'
+    end
+
+    def self.resource_url(opts={})
       '/v1/red_envelopes'
     end
 

data/lib/pingpp/refund.rb

@@ -1,14 +1,23 @@
 module Pingpp
   class Refund < APIResource
-    include Pingpp::APIOperations::Update
-    include Pingpp::APIOperations::List
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
 
-    def url
-      "#{Charge.url}/#{CGI.escape(charge)}/refunds/#{CGI.escape(id)}"
+    def self.retrieve(charge, id, opts={})
+      opts[:parents] = ['charges', charge]
+      super(id, opts)
     end
 
-    def self.retrieve(id, api_key=nil)
-      raise NotImplementedError.new("Refunds cannot be retrieved without a charge ID. Retrieve a refund using charge.refunds.retrieve('refund_id')")
+    def self.create(charge, params, opts={})
+      opts[:parents] = ['charges', charge]
+      super(params, opts)
     end
+
+    def self.list(charge, filters={}, opts={})
+      opts[:parents] = ['charges', charge]
+      super(filters, opts)
+    end
+
+    singleton_class.send(:alias_method, :all, :list)
   end
 end

data/lib/pingpp/singleton_api_resource.rb

@@ -1,18 +1,18 @@
 module Pingpp
   class SingletonAPIResource < APIResource
-    def self.url
+    def self.resource_url(opts={})
       if self == SingletonAPIResource
-        raise NotImplementedError.new('SingletonAPIResource is an abstract class.  You should perform actions on its subclasses (Account, etc.)')
+        raise NotImplementedError.new('SingletonAPIResource is an abstract class.')
       end
       "/v1/#{CGI.escape(class_name.downcase)}"
     end
 
-    def url
-      self.class.url
+    def resource_url(opts={})
+      self.class.resource_url(opts)
     end
 
-    def self.retrieve(api_key=nil)
-      instance = self.new(nil, api_key)
+    def self.retrieve(opts={})
+      instance = self.new(nil, Util.normalize_opts(opts))
       instance.refresh
       instance
     end

data/lib/pingpp/transfer.rb

@@ -1,12 +1,16 @@
 module Pingpp
   class Transfer < APIResource
-    include Pingpp::APIOperations::List
-    include Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
     include Pingpp::APIOperations::Update
 
-    def self.url
+    def self.resource_url(opts={})
       '/v1/transfers'
     end
 
+    def self.cancel(id, opts={})
+      update(id, {:status => 'canceled'}, opts)
+    end
+
   end
 end

data/lib/pingpp/util.rb

@@ -22,17 +22,19 @@ module Pingpp
         'refund' => Refund,
         'red_envelope' => RedEnvelope,
         'transfer' => Transfer,
-        'event' => Event
+        'batch_refund' => BatchRefund,
+        'batch_transfer' => BatchTransfer,
+        'customs' => Customs
       }
     end
 
-    def self.convert_to_pingpp_object(resp, api_key)
+    def self.convert_to_pingpp_object(resp, opts)
       case resp
       when Array
-        resp.map { |i| convert_to_pingpp_object(i, api_key) }
+        resp.map { |i| convert_to_pingpp_object(i, opts) }
       when Hash
         # Try converting to a known object class.  If none available, fall back to generic PingppObject
-        object_classes.fetch(resp[:object], PingppObject).construct_from(resp, api_key)
+        object_classes.fetch(resp[:object], PingppObject).construct_from(resp, opts)
       else
         resp
       end
@@ -68,13 +70,13 @@ module Pingpp
     end
 
     def self.url_encode(key)
-      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      CGI.escape(key.to_s).gsub('%5B', '[').gsub('%5D', ']')
     end
 
     def self.flatten_params(params, parent_key=nil)
       result = []
       params.each do |key, value|
-        calculated_key = parent_key ? "#{parent_key}[#{url_encode(key)}]" : url_encode(key)
+        calculated_key = parent_key ? "#{parent_key}[#{key}]" : "#{key}"
         if value.is_a?(Hash)
           result += flatten_params(value, calculated_key)
         elsif value.is_a?(Array)
@@ -127,5 +129,49 @@ module Pingpp
 
       return new_headers
     end
+
+    def self.encode_parameters(params)
+      Util.flatten_params(params).
+        map { |k,v| "#{url_encode(k)}=#{url_encode(v)}" }.join('&')
+    end
+
+    def self.normalize_id(id)
+      if id.kind_of?(Hash) # overloaded id
+        params_hash = id.dup
+        id = params_hash.delete(:id)
+      else
+        params_hash = {}
+      end
+      [id, params_hash]
+    end
+
+    def self.normalize_opts(opts)
+      case opts
+      when String
+        {:api_key => opts}
+      when Hash
+        check_api_key!(opts.fetch(:api_key)) if opts.has_key?(:api_key)
+        check_app!(opts.fetch(:app)) if opts.has_key?(:app)
+        check_user!(opts.fetch(:user)) if opts.has_key?(:user)
+        opts.clone
+      else
+        raise TypeError.new('normalize_opts expects a string or a hash')
+      end
+    end
+
+    def self.check_api_key!(key)
+      raise TypeError.new("api_key must be a string") unless key.is_a?(String)
+      key
+    end
+
+    def self.check_app!(app)
+      raise TypeError.new("app must be a string") unless app.is_a?(String)
+      app
+    end
+
+    def self.check_user!(user)
+      raise TypeError.new("user must be a string") unless user.is_a?(String)
+      user
+    end
   end
 end

data/lib/pingpp/version.rb

@@ -1,3 +1,3 @@
 module Pingpp
-  VERSION = '2.0.15'
+  VERSION = '2.1.0'
 end

data/lib/pingpp/webhook.rb

@@ -1,7 +1,7 @@
 module Pingpp
   module Webhook
-    def self.verify?(request)
-      if !Pingpp.pub_key
+    def self.verify?(request, pub_key=Pingpp.pub_key)
+      if !pub_key
         return false
       end
 
@@ -27,7 +27,7 @@ module Pingpp
       return false if !formated_headers.has_key?(:x_pingplusplus_signature)
 
       signature = formated_headers[:x_pingplusplus_signature]
-      rsa_public_key = OpenSSL::PKey.read(Pingpp.pub_key)
+      rsa_public_key = OpenSSL::PKey.read(pub_key)
       return rsa_public_key.verify(OpenSSL::Digest::SHA256.new, Base64.decode64(signature), raw_data)
     end
   end

data/lib/pingpp/wx_pub_oauth.rb

@@ -9,7 +9,7 @@ module Pingpp
         'response_type' => 'code',
         'scope' => more_info ? 'snsapi_userinfo' : 'snsapi_base'
       }
-      query_str = Pingpp.uri_encode(query_parts)
+      query_str = Util.encode_parameters(query_parts)
       'https://open.weixin.qq.com/connect/oauth2/authorize?' + query_str + '#wechat_redirect'
     end
 
@@ -30,7 +30,7 @@ module Pingpp
         'code' => code,
         'grant_type' => 'authorization_code'
       }
-      query_str = Pingpp.uri_encode(query_parts)
+      query_str = Util.encode_parameters(query_parts)
       'https://api.weixin.qq.com/sns/oauth2/access_token?' + query_str
     end
 
@@ -54,7 +54,7 @@ module Pingpp
         'secret' => app_secret,
         'grant_type' => 'client_credential'
       }
-      query_str = Pingpp.uri_encode(query_parts)
+      query_str = Util.encode_parameters(query_parts)
       access_token_url = 'https://api.weixin.qq.com/cgi-bin/token?' + query_str
       resp = get_request(access_token_url)
       if !resp['errcode'].nil? then
@@ -64,9 +64,11 @@ module Pingpp
         'access_token' => resp['access_token'],
         'type' => 'jsapi'
       }
-      query_str = Pingpp.uri_encode(query_parts)
+      query_str = Util.encode_parameters(query_parts)
       jsapi_ticket_url = 'https://api.weixin.qq.com/cgi-bin/ticket/getticket?' + query_str
       jsapi_ticket = get_request(jsapi_ticket_url)
+
+      return jsapi_ticket
     end
 
     def self.get_signature(charge, jsapi_ticket, url)
@@ -81,6 +83,8 @@ module Pingpp
         'url=' + url.split('#')[0]
       ]
       signature = Digest::SHA1.hexdigest(array_to_sign.join('&'))
+
+      return signature
     end
   end
 end