afmotion 0.9.0 → 2.0.0.rc1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NWRhODIzZDU2NDU2NTgyODMyYmFlNTBhMWM4N2ZkODg1YzQ0NzI1Nw==
-  data.tar.gz: !binary |-
-    NTg1ZGUwYjNkZmViM2EyZWNlYTJiNmFjM2E0ZDc2YzUxNGJmMGQ5OQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZTBhZDVmZjVhYmM5ZjU0OTIyMWUwMzEzZjQ0N2JkOGIzYWE1NmNiNzkzZDZh
-    ZjM1N2M5ZDQxYjVkYTllODU4MzJkYmU4MTM2NzAwMjM3OTQ2ODU4MTdkNzI3
-    N2U2N2YwMjczN2MxZjk2Mzg2ZjAzODUzYmRkMjFkOTkzZjYyNDI=
-  data.tar.gz: !binary |-
-    ZGIwZGFhYjI0NzYxNGIxZWI3MDQ0NzlmZjZkODNmMTQ3NzUxNjdhNTA4NGM5
-    M2U1NTgyZTdhMWQwZjhiZjczMjFiMWRhYWQ3MjA5MmMzNzJmNTZmMWY0NGM1
-    MjllNTE5Mzc2YmUxZmY1MGI0ZjlkZGI3ZTkyNzM5ZTFlNmNjOTQ=
+SHA1:
+  metadata.gz: 6272282a85e6fd949a516177786517a7be33bc12
+  data.tar.gz: c60b1826698311ed4f8d1d249fe55b67e1df332b
+SHA512:
+  metadata.gz: a353b2ecc16ac721bc08bc893eb5da6001a3dcb0c0b0616dbfc47c43a02047739cead584e6d8393aaa1531b8b92ee2ad8b4d53bc313d1f4536ff45d9223b2476
+  data.tar.gz: 42d31e7089ce294031b79b3e37cd1483138f7b9f998369d5677eff2350b972b5dd10914bee192f472680de1f126dac72dba8846bcf22144814f4e751252b9733

data/AFMotion.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency "motion-cocoapods", "~> 1.3.6"
+  s.add_dependency "motion-cocoapods", "~> 1.4.0"
+  s.add_dependency "motion-require", "~> 0.0.7"
   s.add_development_dependency 'rake'
 end

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    afmotion (0.9.0)
-      motion-cocoapods (~> 1.3.6)
+    afmotion (2.0.0.rc1)
+      motion-cocoapods (~> 1.4.0)
+      motion-require (~> 0.0.7)
 
 GEM
   remote: https://rubygems.org/
@@ -11,33 +12,34 @@ GEM
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     claide (0.3.2)
-    cocoapods (0.23.0)
-      activesupport (~> 3.2.13)
+    cocoapods (0.26.2)
+      activesupport (~> 3.2)
       claide (~> 0.3.2)
-      cocoapods-core (= 0.23.0)
-      cocoapods-downloader (~> 0.1.2)
+      cocoapods-core (= 0.26.2)
+      cocoapods-downloader (~> 0.2.0)
       colored (~> 1.2)
       escape (~> 0.0.4)
-      json (~> 1.8.0)
-      open4 (~> 1.3.0)
-      xcodeproj (~> 0.9.0)
-    cocoapods-core (0.23.0)
-      activesupport (~> 3.2.13)
-      json (~> 1.8.0)
-      nap (~> 0.5.1)
-    cocoapods-downloader (0.1.2)
+      json (~> 1.8)
+      open4 (~> 1.3)
+      xcodeproj (~> 0.13.0)
+    cocoapods-core (0.26.2)
+      activesupport (~> 3.0)
+      json (~> 1.8)
+      nap (~> 0.5)
+    cocoapods-downloader (0.2.0)
     colored (1.2)
     escape (0.0.4)
     i18n (0.6.5)
     json (1.8.0)
-    motion-cocoapods (1.3.6)
-      cocoapods (>= 0.17.0)
-    multi_json (1.7.9)
+    motion-cocoapods (1.4.0)
+      cocoapods (>= 0.26.2)
+    motion-require (0.0.7)
+    multi_json (1.8.0)
     nap (0.5.1)
     open4 (1.3.0)
-    rake (0.9.2.2)
-    xcodeproj (0.9.0)
-      activesupport (~> 3.2.13)
+    rake (10.1.0)
+    xcodeproj (0.13.1)
+      activesupport (~> 3.0)
       colored (~> 1.2)
 
 PLATFORMS

data/README.md

@@ -18,26 +18,51 @@ end
 
 ### Web Services
 
-If you're interacting with a web service, you can use `AFHTTPClient` with this nice wrapper:
-
 ```ruby
-# DSL Mapping to properties of AFHTTPClient
 
-AFMotion::Client.build_shared("https://alpha-api.app.net/") do
-  header "Accept", "application/json"
+@client = AFMotion::... # create your client
 
-  operation :json
-end
-
-AFMotion::Client.shared.get("stream/0/posts/stream/global") do |result|
+@client.get("stream/0/posts/stream/global") do |result|
   if result.success?
-    p result.object
+    p (result.operation || result.task) # depending on your client
   elsif result.failure?
     p result.error.localizedDescription
   end
 end
 ```
 
+You can either use `AFMotion::Client` or `AFMotion::SessionClient` to group similar requests. They have identical APIs, except for their creation and that their request `result` objects contain either `result.operation` (for `::Client`) or `result.task` (for `::SessionClient`).
+
+#### AFMotion::Client
+
+If you're interacting with a web service, you can use [`AFHTTPRequestOperationManager`](http://cocoadocs.org/docsets/AFNetworking/2.0.0/Classes/AFHTTPRequestOperationManager.html) with this nice wrapper:
+
+```ruby
+# DSL Mapping to properties of AFHTTPRequestOperationManager
+
+@client = AFMotion::Client.build("https://alpha-api.app.net/") do
+  header "Accept", "application/json"
+
+  response_serializer :json
+end
+```
+
+#### AFMotion::SessionClient
+
+If you're using iOS7, you can use [`AFHTTPSessionManager`](http://cocoadocs.org/docsets/AFNetworking/2.0.0/Classes/AFHTTPSessionManager.html):
+
+```ruby
+# DSL Mapping to properties of AFHTTPSessionManager
+
+@client = AFMotion::SessionClient.build("https://alpha-api.app.net/") do
+  session_configuration :default
+
+  header "Accept", "application/json"
+
+  response_serializer :json
+end
+```
+
 ### Images
 
 Loading images from the internet is pretty common. AFNetworking's existing methods aren't bad at all, but just incase you want extra Ruby:
@@ -66,18 +91,6 @@ You can also request arbitrary images:
 
 2. `require 'afmotion'` or add to your `Gemfile`
 
-3. In your `Rakefile`, add:
-
-```ruby
-Motion::Project::App.setup do |app|
-  ...
-
-  app.pods do
-    pod 'AFNetworking'
-  end
-end
-```
-
 ## Overview
 
 ### Results
@@ -104,22 +117,6 @@ AFMotion::some_function do |result|
 end
 ```
 
-### Operations
-
-There are wrappers for each `AFURLConnectionOperation` subclass, each of the form:
-
-```ruby
-AFMotion::Operation::[Operation Type].for_request(ns_url_request) do |result|
-  ...
-end
-```
-
-- `AFMotion::Operation::HTTP.for_request...`
-- `AFMotion::Operation::JSON.for_request...`
-- `AFMotion::Operation::XML.for_request...`
-- `AFMotion::Operation::PLIST.for_request...`
-- `AFMotion::Operation::Image.for_request...`
-
 ### One-off Requests
 
 There are wrappers which automatically run a URL request for a given URL and HTTP method, of the form:
@@ -146,23 +143,43 @@ end
 
 ### HTTP Client
 
-If you're constantly accesing a web service, it's a good idea to use an `AFHTTPClient`. Things lets you add a common base URL and request headers to all the requests issued through it, like so:
+If you're constantly accesing a web service, it's a good idea to use an `AFHTTPRequestOperationManager`. Things lets you add a common base URL and request headers to all the requests issued through it, like so:
 
 ```ruby
 client = AFMotion::Client.build("https://alpha-api.app.net/") do
   header "Accept", "application/json"
 
-  operation :json
+  response_serializer :json
 end
 
 client.get("stream/0/posts/stream/global") do |result|
+  # result.operation exists
+  ...
+end
+```
+
+If you're using iOS7, you can use [`AFHTTPSessionManager`](http://cocoadocs.org/docsets/AFNetworking/2.0.0/Classes/AFHTTPSessionManager.html):
+
+```ruby
+# DSL Mapping to properties of AFHTTPSessionManager
+
+client = AFMotion::SessionClient.build("https://alpha-api.app.net/") do
+  session_configuration :default
+
+  header "Accept", "application/json"
+
+  response_serializer :json
+end
+
+client.get("stream/0/posts/stream/global") do |result|
+  # result.task exists
   ...
 end
 ```
 
 If you're constantly used one web service, you can use the `AFMotion::Client.shared` variable have a common reference. It can be set like a normal variable or created with `AFMotion::Client.build_shared`.
 
-`AFHTTPClient` supports methods of the form `AFHTTPClient#get/post/put/patch/delete(url, request_parameters)`. The `request_parameters` is a hash containing your parameters to attach as the request body or URL parameters, depending on request type. For example:
+`AFHTTPRequestOperationManager` & `AFHTTPSessionManager` support methods of the form `Client#get/post/put/patch/delete(url, request_parameters)`. The `request_parameters` is a hash containing your parameters to attach as the request body or URL parameters, depending on request type. For example:
 
 ```ruby
 client.get("users", id: 1) do |result|
@@ -176,14 +193,14 @@ end
 
 #### Multipart Requests
 
-`AFHTTPClient` supports multipart form requests (i.e. for image uploading). Simply prepend `multipart!` to any other request method and it'll convert your parameters into properly encoded multipart data:
+`AFHTTPRequestOperationManager` & `AFHTTPSessionManager` support multipart form requests (i.e. for image uploading) - simply use `multipart_post` and it'll convert your parameters into properly encoded multipart data. For all other types of request data, use the `form_data` object passed to your callback:
 
 ```ruby
 # an instance of UIImage
 image = my_function.get_image
 data = UIImagePNGRepresentation(image)
 
-client.multipart!.post("avatars") do |result, form_data|
+client.multipart_post("avatars") do |result, form_data|
   if form_data
     # Called before request runs
     # see: https://github.com/AFNetworking/AFNetworking/wiki/AFNetworking-FAQ
@@ -196,17 +213,20 @@ client.multipart!.post("avatars") do |result, form_data|
 end
 ```
 
+This is an instance of [`AFMultipartFormData`](http://cocoadocs.org/docsets/AFNetworking/2.0.0/Protocols/AFMultipartFormData.html).
+
 If you want to track upload progress, you can add a third callback argument which returns the upload percentage between 0.0 and 1.0:
 
 ```ruby
-client.multipart!.post("avatars") do |result, form_data, progress|
+client.multipart_post("avatars") do |result, form_data, progress|
   if form_data
     # Called before request runs
     # see: https://github.com/AFNetworking/AFNetworking/wiki/AFNetworking-FAQ
     form_data.appendPartWithFileData(data, name: "avatar", fileName:"avatar.png", mimeType: "image/png")
   elsif progress
-    # 0.0 <= progress <= 1.0
+    # 0.0 < progress < 1.0
     my_widget.update_progress(progress)
+  else
   ...
 end
 ```
@@ -226,26 +246,15 @@ client.headers.delete "Accept"
 #=> "application/something_else"
 ```
 
-#### Client Operations
-
-If you want to grab an `AFURLConnectionOperation` from your client instance, use `create_operation` or `create_multipart_operation`:
-
-```ruby
-operation = client.create_operation(:get, "http://google.com", {q: "hello"}) do |result|
-end
-
-multipart_operation = client.create_multipart_operation(:get, "http://google.com", {q: "hello"}) do |result, form_data, progress|
-end
-
-# elsewhere
-client.enqueueHTTPRequestOperation(operation)
-```
-
 #### Client Building DSL
 
-The `AFMotion::Client` DSL allows the following properties:
+The `AFMotion::Client` & `AFMotion::SessionClient` DSLs allows the following properties:
 
 - `header(header, value)`
 - `authorization(username: ___, password: ____)` for HTTP Basic auth, or `authorization(token: ____)` for Token based auth.
-- `operation(operation_type)`. Allows you to set a common operation class for all your client's requests. So if your API is always going to be JSON, you should set `operation(:json)`. Accepts `:json`, `:plist`, `:xml`, or `:http`
-- `parameter_encoding(encoding)`. Allows you to set a body format for requests parameters. For example, when you send a POST request you might want the parameters to be encoding as a JSON object instead of the traditional `key=val` format. Accepts `:json`, `:plist`, and `:form` (normal encoding).
+- `request_serializer(serializer)`. Allows you to set an [`AFURLRequestSerialization`](http://cocoadocs.org/docsets/AFNetworking/2.0.0/Protocols/AFURLRequestSerialization.html) for all your client's requests, which determines how data is encoded on the way to the server. So if your API is always going to be JSON, you should set `operation(:json)`. Accepts `:json` and `:plist`, or any instance of `AFURLRequestSerialization`.
+- `response_serializer(serializer)`. Allows you to set an [`AFURLResponseSerialization`](http://cocoadocs.org/docsets/AFNetworking/2.0.0/Protocols/AFURLResponseSerialization.html), which determines how data is decoded once the server respnds. Accepts `:json`, `:xml`, `:plist`, `:image`, `:http`, or any instance of `AFURLResponseSerialization`.
+
+For `AFMotion::SessionClient` only:
+
+- `session_configuration(session_configuration, identifier = nil)`. Allows you to set the [`NSURLSessionConfiguration`](https://developer.apple.com/library/ios/documentation/Foundation/Reference/NSURLSessionConfiguration_class/Reference/Reference.html#//apple_ref/occ/cl/NSURLSessionConfiguration). Accepts `:default`, `:ephemeral`, `:background` (with the `identifier` as a String), or an instance of `NSURLSessionConfiguration`.

data/Rakefile

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 $:.unshift("/Library/RubyMotion/lib")
-require 'motion/project'
+require 'motion/project/template/ios'
 require "bundler/gem_tasks"
 require "bundler/setup"
 Bundler.require :default
@@ -11,8 +11,4 @@ require './lib/afmotion'
 Motion::Project::App.setup do |app|
   # Use `rake config' to see complete project settings.
   app.name = 'AFMotion'
-
-  app.pods do
-    pod "AFNetworking"
-  end
 end

data/lib/afmotion/client_shared.rb

@@ -0,0 +1,90 @@
+module AFMotion
+  module ClientShared
+    def headers
+      requestSerializer.headers
+    end
+
+    def all_headers
+      requestSerializer.HTTPRequestHeaders
+    end
+
+    def authorization=(authorization)
+      requestSerializer.authorization = authorization
+    end
+
+    def multipart_post(path, parameters = {}, &callback)
+      create_multipart_operation(path, parameters, &callback)
+    end
+
+    def create_multipart_operation(path, parameters = {}, &callback)
+      parameters = AFMotion::MultipartParametersWrapper.new(parameters)
+      inner_callback = Proc.new do |result, form_data,  bytes_written_now,  total_bytes_written, total_bytes_expect|
+
+        case callback.arity
+        when 1
+          callback.call(result)
+        when 2
+          callback.call(result, form_data)
+        when 3
+          progress = nil
+          if total_bytes_written && total_bytes_expect
+            progress = total_bytes_written.to_f / total_bytes_expect.to_f
+          end
+          callback.call(result, form_data, progress)
+        when 5
+          callback.call(result, form_data, bytes_written_now, total_bytes_written, total_bytes_expect)
+        end
+      end
+
+      multipart_callback = nil
+      if callback.arity == 2
+        multipart_callback = lambda { |formData|
+          inner_callback.call(nil, formData)
+        }
+      end
+
+      upload_callback = nil
+      if callback.arity > 2
+        upload_callback = lambda { |bytes_written_now, total_bytes_written, total_bytes_expect|
+          inner_callback.call(nil, nil, bytes_written_now, total_bytes_written, total_bytes_expect)
+        }
+      end
+
+      operation = self.POST(path,
+        parameters: parameters,
+        constructingBodyWithBlock: multipart_callback,
+        success: lambda {|operation, responseObject|
+          result = AFMotion::HTTPResult.new(operation, responseObject, nil)
+          inner_callback.call(result)
+        }, failure: lambda {|operation, error|
+          result = AFMotion::HTTPResult.new(operation, nil, error)
+          inner_callback.call(result)
+        })
+      if upload_callback
+        operation.setUploadProgressBlock(upload_callback)
+      end
+      operation
+    end
+
+    def create_operation(http_method, path, parameters = {}, &callback)
+      method_signature = "#{http_method.upcase}:parameters:success:failure:"
+      method = self.method(method_signature)
+      success_block = AFMotion::Operation.success_block_for_http_method(http_method, callback)
+      operation = method.call(path, parameters, success_block, AFMotion::Operation.failure_block(callback))
+    end
+
+    alias_method :create_task, :create_operation
+
+    private
+    # To force RubyMotion pre-compilation of these methods
+    def dummy
+      self.GET("", parameters: nil, success: nil, failure: nil)
+      self.HEAD("", parameters: nil, success: nil, failure: nil)
+      self.POST("", parameters: nil, success: nil, failure: nil)
+      self.POST("", parameters: nil, constructingBodyWithBlock: nil, success: nil, failure: nil)
+      self.PUT("", parameters: nil, success: nil, failure: nil)
+      self.DELETE("", parameters: nil, success: nil, failure: nil)
+      self.PATCH("", parameters: nil, success: nil, failure: nil)
+    end
+  end
+end

data/lib/afmotion/http.rb

@@ -1,92 +1,52 @@
-module AFMotion
-  module HTTPBuilder
-    def self.included(base)
-      AFMotion::HTTP_METHODS.each do |method|
-        base.send(:define_singleton_method, method, -> (request_or_url, parameters = {}, &callback) do
-          request = request_or_url
-          if !request.is_a?(NSURLRequest)
-            request = NSMutableURLRequest.requestWithURL(request_or_url.to_url)
-            request.HTTPMethod = method.upcase
-            if [:get, :head].member? method.downcase.to_sym
-              request.HTTPShouldUsePipelining = true
-            end
-            # SEE NSURLRequest_params.rb
-            request.parameters = parameters.merge(__encoding__: self.parameter_encoding)
-          end
-
-          operation = (self.request_module.for_request(request) do |result|
-            callback.call(result)
-          end)
+motion_require 'version'
 
-          operation.start
-          operation
-        end)
+module AFMotion
+  class HTTP
+    def self.operation_manager
+      @operation_manager ||= begin
+        manager = AFHTTPRequestOperationManager.manager
+        configure_manager(manager)
+        manager
       end
     end
-  end
-
-  module HTTP
-    include AFMotion::HTTPBuilder
 
-    module_function
-    def request_module
-      AFMotion::Operation::HTTP
-    end
-
-    def parameter_encoding
-      AFFormURLParameterEncoding
+    def self.configure_manager(manager)
     end
   end
 
-  module JSON
-    include AFMotion::HTTPBuilder
-
-    module_function
-    def request_module
-      AFMotion::Operation::JSON
-    end
-
-    def parameter_encoding
-      AFJSONParameterEncoding
+  class JSON < HTTP
+    def self.configure_manager(manager)
+      manager.json!
     end
   end
 
-  module XML
-    include AFMotion::HTTPBuilder
-
-    module_function
-    def request_module
-      AFMotion::Operation::XML
-    end
-
-    def parameter_encoding
-      AFFormURLParameterEncoding
+  class XML < HTTP
+    def self.configure_manager(manager)
+      manager.xml!
     end
   end
 
-  module PLIST
-    include AFMotion::HTTPBuilder
-
-    module_function
-    def request_module
-      AFMotion::Operation::PLIST
-    end
-
-    def parameter_encoding
-      AFPropertyListParameterEncoding
+  class PLIST < HTTP
+    def self.configure_manager(manager)
+      manager.plist!
     end
   end
 
-  module Image
-    include AFMotion::HTTPBuilder
-
-    module_function
-    def request_module
-      AFMotion::Operation::Image
+  class Image < HTTP
+    def self.configure_manager(operation)
+      operation.image!
     end
+  end
 
-    def parameter_encoding
-      AFFormURLParameterEncoding
+  [HTTP, JSON, XML, PLIST, Image].each do |base|
+    AFMotion::HTTP_METHODS.each do |method_name|
+      method_signature = "#{method_name.to_s.upcase}:parameters:success:failure:"
+      base.define_singleton_method(method_name, -> (url, parameters = {}, &callback) do
+        base.operation_manager.send(method_signature, url,
+          parameters,
+          AFMotion::Operation.success_block_for_http_method(method_name, callback),
+          AFMotion::Operation.failure_block(callback))
+      end)
     end
   end
 end