faraday_resource 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bcf5c6561c707b847aa43837c78a6dbf3cd243f
-  data.tar.gz: 087ba8624ff63f502bc84981d7816a1f3d1963c5
+  metadata.gz: 1e2fb02c19a3344fba6d826e7ef018a2968d7185
+  data.tar.gz: d24468b32baa8324b73e0e17026617853a1d7e72
 SHA512:
-  metadata.gz: 8367a8f18e86c603ad21517d7dfbdec2ac235f53a63d4c8ff9a9fa0cb3ccb290e11827393eab0be32b57b2928ab7efcdc85fa91f002e8e6c0d021831b11c3ba8
-  data.tar.gz: ccd4ad1a86753a0c73a1a14a7ababa505b62ea3b80b5f6a3a7714d0c2c5b3c0329fca08e7f5727f6c28bc3cde756ee299202b12d04cfbe766eeab3ee80628198
+  metadata.gz: 3cb5432c68b1d0095cc048847d334a9edf3c5d2ed2990306c354a4f5b27e3a04d0e43be188d77606f58a4038f06b940f68dcf43d0c4af656cf99d3875bd8a08e
+  data.tar.gz: 8684a7642790cabec7bdc4abf17e6d04b786ed7a267585789691eb53928f46cfb76c811d03dabc6e9eb72423917607f6e60bf4d29dc08f2c7a0348317b0f6ab5

data/README.md

@@ -22,7 +22,161 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+
+such as:		
+ 
+```
+	
+	class User
+	  include FaradayResource::Base
+	
+	  set_url 'http://localhost:5100'
+	
+	  set_content_type 'application/json'
+	
+	  get :load, 'url' => '/users/:id', 'params' => {:test => 'dfdjfk', :id => 1}
+	
+	  collection do
+	    get :get_list, 'url' => '/users', 'is_array' => true
+	  end
+	end
+```
+	
+now you can use User class such as:
+
+
+
+```
+	user = User.new
+	response = user.load #=> fetch data
+	user.name #=> get name
+	response.status #=> status code faraday response	
+```
+
+	
+
+if is_array is true return response and array[user] or only response
+
+	
+	
+	
+```
+	response, users = User.get_list #=> only when is_array is true
+	response.status #=> status code faraday response
+	users.class #=> Array, array[user]
+	
+	response = User.get_list #=> when is_array is false 
+```
+	
+overwrite url params
+
+	
+```
+	User.get_list({
+		:url => '/other_users',
+		:params => {
+			:q => 'wp'
+		}
+	})
+	
+	#now faraday use '/other_users' and params will merge this params
+```
+
+	
+you can set custom parse function for instance_methods (default JSON.parse)
+
+	
+
+```
+
+	class User
+		set_parse do |body|
+			JSON.parse(body)['entity']
+		end
+	end
+```
+
+	
+you can set custom array_parse function for is_array is true (default JSON.parse)
+
+		
+		
+```
+	class User
+		set_array_parse do |body|
+			JSON.parse(body)['entities']
+		end
+	end
+```
+
+	
+you can set global setting (will be overwitten by class set_url..)
+
+	
+```
+	FaradayResource.configure do |settings|
+	  settings.url = 'http://localhost:5100'
+	  settings.content_type = 'application/json'
+	end
+	
+```
+	
+url params xxx will replaced by params[:xxx] or params[xxx]		
+	
+```			
+	class User
+	
+		get :load, 'url' => '/users/:id', 'params' => {:test => 'dfdjfk', :id => 1} do |params, instance|
+		    params['test'] = instance.name
+		    params
+		end
+	end
+```
+	
+	
+get/post/put/delete methods (not in collection) can accept block (params, instance then return params)
+
+	
+```			
+	class User
+	
+		put :update, 'url' => '/users/:id', 'params' => {} do |params, instance|
+		    params['user'] = {
+		    	:name => instance.name,
+		    	:age => instance.age
+		    }
+		    params
+		end
+	end
+	
+	u = User.new({id: 2})
+	u.load
+	u.name = 'zkf'
+	u.update
+```
+	
+can assign value for attributes, check stale?
+
+```
+	u = User.new({id: 2})
+	u.load
+	u.name #=> 'wp'
+	u.name = 'zkf'
+	u.name #=> 'zkf'
+	u.stale? #=> true
+	u.stale_attributes #=> {'name': 'wp'}
+```	
+
+
+
+##other
+
+I think this gem will help communicating between app servers (soa)
+
+我水平有限(low)，如果有什么好的想法(good tips)，可以联系我（concat me） qq:524162910  email:wpcreep@gmail.com
+	
+
 
 ## Development
 

data/faraday_resource.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["wpzero"]
   spec.email         = ["wangping@galiumsof.com"]
 
-  spec.summary       = %q{use faraday http client to create REST resource similar to angular resource}
-  spec.description   = %q{use faraday http client to create REST resource similar to angular resource}
+  spec.summary       = %q{REST resource similar to angular resource based on faraday}
+  spec.description   = %q{REST resource similar to angular resource based on faraday}
   spec.homepage      = "https://github.com/wpzero/faraday_resource"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or

data/lib/faraday_resource/base.rb

@@ -1,6 +1,4 @@
-require 'faraday'
-
-# 这个是一个给block绑定一个object的方法
+# 这个是一个给proc绑定一个object的方法
 class Proc
     def call_with_obj(obj, *args)
         m = nil
@@ -17,26 +15,44 @@ module FaradayResource
   module Base
     def self.included(base)
       base.extend(ClassMethods)
-
       # 添加一个attributes的proxy
       base.class_eval do
         def method_missing(name, *args)
-          # 可以代理到attributes中的数据
+          # 可以代理到attributes的取值
           if self.attributes.keys.include? name
             return self.attributes[name]
           elsif self.attributes.keys.include? name.to_s
             return self.attributes[name.to_s]
           end
+          # 可以代理到attributes的赋值
+          result = /^(.+)=$/.match(name.to_s)
+          if result && result[1] && self.attributes[result[1]]
+            # 如果第一次修改旧的记录那么就记录老的数据
+            self.stale_attributes[result[1]] = self.attributes[result[1]] unless self.stale_attributes[result[1]]
+            return self.attributes[result[1]] = args[0]
+          elsif result && result[1] && self.attributes[:"#{result[1]}"]
+            # 如果第一次修改旧的记录那么就记录老的数据
+            self.stale_attributes[:"#{result[1]}"] = self.attributes[:"#{result[1]}"] unless self.stale_attributes[:"#{result[1]}"]
+            return self.attributes[:"#{result[1]}"] = args[0]
+          end
+          # 否则不处理
           super
         end
       end
-
       # 设置一个attributes来存返回的数据
       base.class_eval do
-        attr_accessor :attributes
+        # 存储 attributes 和 旧的 attribtues
+        attr_accessor :attributes, :stale_attributes
 
+        # 初始化
         def initialize attrs={}
           @attributes = attrs
+          @stale_attributes = {}
+        end
+
+        # 判断是否有修改
+        def stale?
+          self.stale_attributes.length > 0
         end
       end
 
@@ -121,23 +137,27 @@ module FaradayResource
         end
 
         # post macro 
-        def post name, method_settings={}
-          inner_create_method name, :post, method_settings
+        def post name, method_settings={}, &method_block
+          method_block ||= lambda{|params, instance|}
+          inner_create_method name, :post, method_settings, method_block
         end
 
         # get macro
-        def get name, method_settings={}
-          inner_create_method name, :get, method_settings
+        def get name, method_settings={}, &method_block
+          method_block ||= lambda{|params, instance|}
+          inner_create_method name, :get, method_settings, method_block
         end
 
         # put macro
-        def put name, method_settings={}
-          inner_create_method name, :put, method_settings
+        def put name, method_settings={}, &method_block
+          method_block ||= lambda{|params, instance|}
+          inner_create_method name, :put, method_settings, method_block
         end
 
         # delete macro
-        def delete name, method_settings={}
-          inner_create_method name, :delete, method_settings
+        def delete name, method_settings={}, &method_block
+          method_block ||= lambda{|params, instance|}
+          inner_create_method name, :delete, method_settings, method_block
         end
 
         # array method 返回的是array[resource]
@@ -147,7 +167,7 @@ module FaradayResource
         end
 
         private 
-        def inner_create_method name, method, method_settings
+        def inner_create_method name, method, method_settings, method_block
           # 定义一个方法
           define_method name do |settings={}|
             dom_url = self.class.url || FaradayResource.config.url
@@ -169,6 +189,7 @@ module FaradayResource
             response = conn.send method do |req|
               req.url re_url
               req.headers['Content-Type'] = settings['Content-Type'] || method_settings['Content-Type'] || self.class.content_type || FaradayResource.config.content_type
+              params = method_block.call(params, self)
               req.params = params
             end
 
@@ -177,6 +198,7 @@ module FaradayResource
                 parse = JSON.method(:parse)
                 parse = self.class.parse if self.class.parse
                 self.attributes = parse.call(response.body)
+                self.stale_attributes = {}
               end
             end
             return response

data/lib/faraday_resource/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday_resource
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - wpzero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2015-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: use faraday http client to create REST resource similar to angular resource
+description: REST resource similar to angular resource based on faraday
 email:
 - wangping@galiumsof.com
 executables: []
@@ -93,5 +93,5 @@ rubyforge_project:
 rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
-summary: use faraday http client to create REST resource similar to angular resource
+summary: REST resource similar to angular resource based on faraday
 test_files: []