under-os-http 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1b0c0d55e665fc548b88e13195fdb1ae78fd3ff
+  data.tar.gz: b6f44330bd12f8eefed0599735e3cdeda7d46479
+SHA512:
+  metadata.gz: 96e130ed94fa445e267f37705e4a4411c92e90e31f3f2d7a87030d91a7678662c29fbaec08e10933594655c827bfdfabdc14e19971c350e84fbf6a32dfccd1fc
+  data.tar.gz: 6777d5795d5cf5bf35ad8b9fab2fdf46d44407f302ea14f5b332c7fd09ae0ad3901a826b788be7274c0dcf2542f02632a58be638792701bb4f457afc25eba7c2

data/README.md

@@ -0,0 +1,26 @@
+# UnderOs Core
+
+This is the HTTP stack module for the [UnderOs](http://under-os.com) project
+
+## Copyright & License
+
+All code in this library is released under the terms of the MIT license
+
+Copyright (C) 2013-2014 Nikolay Nemshilov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/core/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def to_query(key)
+    collect { |value| value.to_query("#{key}[]") }.join '&'
+  end
+end

data/lib/core/hash.rb

@@ -0,0 +1,10 @@
+class Hash
+  #
+  # Converts a hash into an URL query string
+  #
+  def to_query(namespace=nil)
+    map do |key, value|
+      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+    end.sort * '&'
+  end
+end

data/lib/core/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def to_query(key)
+    "#{key.to_s.url_encode}=#{to_s.url_encode}"
+  end
+end

data/lib/core/string.rb

@@ -0,0 +1,9 @@
+class String
+  def url_encode(encoding=nil)
+    stringByAddingPercentEscapesUsingEncoding ENCODINGS[encoding] || NSUTF8StringEncoding
+  end
+
+  def url_decode(encoding=nil)
+    stringByReplacingPercentEscapesUsingEncoding ENCODINGS[encoding] || NSUTF8StringEncoding
+  end
+end

data/lib/under-os-http.rb

@@ -0,0 +1 @@
+UnderOs.extend __FILE__

data/lib/under_os/http.rb

@@ -0,0 +1,31 @@
+class UnderOs::HTTP
+  def self.get(url, options={}, &block)
+    request url, options.merge(method: :get), &block
+  end
+
+  def self.post(url, options={}, &block)
+    request url, options.merge(method: :post), &block
+  end
+
+  def self.put(url, options={}, &block)
+    request url, options.merge(method: :put), &block
+  end
+
+  def self.patch(url, options={}, &block)
+    request url, options.merge(method: :patch), &block
+  end
+
+  def self.head(url, options={}, &block)
+    request url, options.merge(method: :head), &block
+  end
+
+  def self.delete(url, options={}, &block)
+    request url, options.merge(method: :delete), &block
+  end
+
+protected
+
+  def self.request(*args, &block)
+    Request.new(*args, &block).send
+  end
+end

data/lib/under_os/http/cookies.rb

@@ -0,0 +1,30 @@
+#
+# A simple cookie jar thing
+#
+class UnderOs::HTTP::Cookies
+  def initialize(cookies, url)
+    @url  = url.is_a?(String) ? NSURL.URLWithString(url) : url
+    @hash = cookies
+  end
+
+  def headers
+    NSHTTPCookie.requestHeaderFieldsWithCookies(ios_cookies)
+  end
+
+  def to_s
+    headers["Cookie"]
+  end
+
+protected
+
+  def ios_cookies
+    @hash.map do |key, value|
+      NSHTTPCookie.cookieWithProperties({
+        NSHTTPCookieDomain => @url.host,
+        NSHTTPCookiePath   => "/",
+        NSHTTPCookieName   => key.to_s,
+        NSHTTPCookieValue  => value.to_s
+      })
+    end
+  end
+end

data/lib/under_os/http/receiver.rb

@@ -0,0 +1,44 @@
+#
+# A little wrap to handle iOS HTTP requests receiving
+#
+class UnderOs::HTTP::Request
+  class Receiver
+    def initialize(request, stream=false)
+      @request = request
+      @stream  = stream
+      @data    = NSMutableData.dataWithCapacity(0)
+    end
+
+    def connection(connection, didReceiveResponse:response)
+      @data.setLength(0)
+      @response = UnderOs::HTTP::Response.new(response, @data)
+
+      emit(:response)
+    end
+
+    def connection(connection, didReceiveData:data)
+      @data.setLength(0) if @stream
+      @data.appendData(data)
+      emit(:data)
+    end
+
+    # def connection(connection, willCacheResponse:cachedResponse)
+    #   return nil # don't cache
+    # end
+
+    def connection(connection, didFailWithError:error)
+      @response = UnderOs::HTTP::Response.new(error, @data)
+
+      emit(:failure)
+    end
+
+    def connectionDidFinishLoading(connection)
+      emit(:success)
+    end
+
+    def emit(event)
+      @request.emit(event, response: @response)
+      @request.emit(:complete, response: @response) if event == :failure || event == :success
+    end
+  end
+end

data/lib/under_os/http/request.rb

@@ -0,0 +1,106 @@
+#
+# Options:
+#
+#   * :method   - GET, POST, ...
+#   * :cookies  - Hash of cookie values
+#   * :stream   - boolean, in case you want to stream stuff
+#   * :params   - the POST/PUT/PATCH params hash
+#   * :encoding - the POST data encoding
+#
+# Events:
+#
+#   * :response - when response header is received
+#   * :data     - when a chunk of data is received
+#   * :success  - when the request is successfully finished
+#   * :failure  - when request has failed for whatever reason
+#   * :complete - when it's complete (either way)
+#
+class UnderOs::HTTP::Request
+  include UnderOs::Events
+
+  attr_reader :url, :method, :params
+
+  def initialize(url, options={}, &block)
+    @url     = url
+    @options = options
+
+    on :complete, &block if block_given?
+  end
+
+  def on(*args, &block)
+    super *args do |event|
+      args = block.arity == 0 ? [] : [event.params[:response]]
+      block.call *args
+    end
+  end
+
+  def send
+    @request    = build_request
+    @receiver   = Receiver.new(self, @options[:stream])
+    @connection = NSURLConnection.alloc.initWithRequest(@request, delegate:@receiver)
+    @connection.start
+
+    return self
+  end
+
+  def cancel
+    @connection.cancel
+
+    return self
+  end
+
+  def method
+    method = @options[:method] || :get
+    method = method.to_s.upcase
+    method = 'GET' unless %w[GET POST PUT DELETE PATCH HEAD].include?(method)
+    method
+  end
+
+  def headers
+    @options[:headers] || {}
+  end
+
+  def cookies
+    @options[:cookies] || {}
+  end
+
+  def params
+    @options[:params] || {}
+  end
+
+  def encoding
+    @options[:encoding] || 'utf-8'
+  end
+
+protected
+
+  def build_request
+    query = params.to_query
+    url   = build_url(query)
+
+    NSMutableURLRequest.requestWithURL(url).tap do |request|
+      request.setHTTPMethod method
+
+      headers.merge(UnderOs::HTTP::Cookies.new(cookies, url).headers).each do |key, value|
+        request.addValue value, forHTTPHeaderField:key
+      end
+
+      if %w[POST PUT PATCH DELETE].include?(method) && !query.empty?
+        request.addValue "application/x-www-form-urlencoded;charset=#{encoding}", forHTTPHeaderField:"Content-Type"
+        request.setHTTPBody query.to_data(encoding)
+      end
+    end
+  end
+
+  def build_url(query)
+    url  = @url
+
+    if method == "GET" && !query.empty?
+      url += url.include?('?') ? '&' : '?'
+      url += query
+    end
+
+    NSURL.URLWithString(url)
+  end
+end
+

data/lib/under_os/http/response.rb

@@ -0,0 +1,28 @@
+class UnderOs::HTTP::Response
+  attr_reader :data
+
+  def initialize(response, data)
+    @response = response
+    @data     = data # raw NSData
+  end
+
+  def headers
+    @response.allHeaderFields
+  end
+
+  def body
+    @body ||= @data.to_s
+  end
+
+  def json
+    JSON.parse(body)
+  end
+
+  def content_length
+    headers["Content-Length"].to_i
+  end
+
+  def content_type
+    headers["Content-Type"]
+  end
+end

data/lib/under_os/http/session.rb

@@ -0,0 +1,49 @@
+#
+# Basically keeps track of cookies between the requests
+#
+class Session
+  def initialize(default_options={})
+    @options = default_options
+    @options[:cookies] ||= {}
+  end
+
+  def cookies
+    @options[:cookies]
+  end
+
+  def get(url, options={}, &block)
+    request(url, {method: 'GET'}.merge(options), &block).send
+  end
+
+  def post(url, options={}, &block)
+    request(url, {method: 'POST'}.merge(options), &block).send
+  end
+
+  def put(url, options={}, &block)
+    request(url, {method: 'PUT'}.merge(options), &block).send
+  end
+
+  def delete(url, options={}, &block)
+    request(url, {method: 'DELETE'}.merge(options), &block).send
+  end
+
+  def request(url, options={}, &block)
+    options = options.merge(@options){|k,a,b| a.merge(b) }
+
+    UnderOs::HTTP::Request.new(url, options, &block).tap do |request|
+      request.on :response do |response|
+        save_cookies response.headers["Set-Cookie"] || ''
+      end
+    end
+  end
+
+protected
+
+  def save_cookies(cookies)
+    cookies.scan(/([a-z_]+?)=([^; ]+)/).each do |key, value|
+      unless ['path', 'domain', 'expires'].include?(key)
+        @options[:cookies][key] = value
+      end
+    end
+  end
+end

data/spec/core/hash_spec.rb

@@ -0,0 +1,19 @@
+describe Hash do
+  describe '#to_query' do
+    it "converts a simple hash into a query string" do
+      {a: 1, b: 2}.to_query.should == 'a=1&b=2'
+    end
+
+    it "converts nested hashes into queries correctly" do
+      {a: 1, b: {c: {d: 4}}}.to_query.should == 'a=1&b%5Bc%5D%5Bd%5D=4'
+    end
+
+    it "handles array values correctly" do
+      {a: [1,2,3,4]}.to_query.should == 'a%5B%5D=1&a%5B%5D=2&a%5B%5D=3&a%5B%5D=4'
+    end
+
+    it "escapes any URL sensitive characters in the values" do
+      {a: '%= '}.to_query.should == 'a=%25=%20'
+    end
+  end
+end

data/spec/core/string_spec.rb

@@ -0,0 +1,21 @@
+describe String do
+  describe '#url_encode' do
+    it "escapes all the URL sensitive symbols" do
+      "!*'\"();:@&=+$,/?%#[]% ".url_encode.should == "!*'%22();:@&=+$,/?%25%23%5B%5D%25%20"
+    end
+
+    it "doesn't touch normal characters" do
+      "Hello World".url_encode.should == "Hello%20World"
+    end
+  end
+
+  describe '#url_decode' do
+    it "converts an url encoded string back to normality" do
+      "!*'%22();:@&=+$,/?%25%23%5B%5D%25%20".url_decode.should == "!*'\"();:@&=+$,/?%#[]% "
+    end
+
+    it "doesn't break normal characters" do
+      "Hello%20World".url_decode.should == "Hello World"
+    end
+  end
+end

data/spec/under_os/http/cookies_spec.rb

@@ -0,0 +1,13 @@
+describe UnderOS::HTTP::Cookies do
+  before do
+    @cookies = UnderOS::HTTP::Cookies.new({a: 1, b: true}, "http://test.com")
+  end
+
+  it "allows to export them in a string" do
+    @cookies.to_s.should == "a=1; b=true"
+  end
+
+  it "allows to export them into an HTTP header hash" do
+    @cookies.headers.should == {"Cookie"=>"a=1; b=true"}
+  end
+end

data/spec/under_os/http/request_spec.rb

@@ -0,0 +1,44 @@
+describe UnderOS::HTTP::Request do
+  before do
+    @url     = "http://test.com"
+    @request = UnderOS::HTTP::Request.new(@url, {
+      headers: {my: 'headers'},
+      cookies: {my: 'cookies'},
+      params:  {my: 'params'},
+      method:  :put
+    })
+  end
+
+  describe "#constructor" do
+    it "assigns the url correctly" do
+      @request.url.should == @url
+    end
+
+    it "assigns the request headers correctly" do
+      @request.headers.should == {my: 'headers'}
+    end
+
+    it "assigns the request cookies correctly" do
+      @request.cookies.should == {my: 'cookies'}
+    end
+
+    it "assigns my params correctly" do
+      @request.params.should == {my: 'params'}
+    end
+
+    it "assigns the request method correctly" do
+      @request.method.should == 'PUT'
+    end
+  end
+
+  describe "#on" do
+    it "returns the response object instead of an event into a callback" do
+      @response = nil
+
+      @request.on(:smth) { |r| @response = r }
+      @request.emit(:smth, response: 'response')
+
+      @response.should == 'response'
+    end
+  end
+end

data/spec/under_os/http_spec.rb

@@ -0,0 +1,20 @@
+describe UnderOs::HTTP do
+  extend Facon::SpecHelpers
+
+  before do
+    @url = 'http://test.com'
+    @req = mock 'request', send: :request
+  end
+
+  %w[get post put patch head delete].each do |method|
+    describe ".#{method}" do
+      it "sends a #{method.upcase} request" do
+        UnderOs::HTTP::Request.should.receive(:new)
+          .with(@url, foo: 'bar', method: method.to_sym)
+          .and_return(@req)
+
+        UnderOs::HTTP.__send__(method, @url, foo: 'bar').should == :request
+      end
+    end
+  end
+end

data/under-os-http.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.dirname(__FILE__) + "/../under-os-core/lib/under_os"
+
+Gem::Specification.new do |gem|
+  gem.name          = "under-os-http"
+  gem.version       = UnderOs::VERSION
+  gem.homepage      = "http://under-os.com"
+
+  gem.authors       = ["Nikolay Nemshilov"]
+  gem.email         = ['nemshilov@gmail.com']
+  gem.description   = "The HTTP stack for the UnderOs project"
+  gem.summary       = "The HTTP stack for the UnderOs project. Summaries FTW"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.add_dependency 'under-os-core', UnderOs::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'motion-facon'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: under-os-http
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Nikolay Nemshilov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: under-os-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: motion-facon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The HTTP stack for the UnderOs project
+email:
+- nemshilov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/core/array.rb
+- lib/core/hash.rb
+- lib/core/object.rb
+- lib/core/string.rb
+- lib/under-os-http.rb
+- lib/under_os/http.rb
+- lib/under_os/http/cookies.rb
+- lib/under_os/http/receiver.rb
+- lib/under_os/http/request.rb
+- lib/under_os/http/response.rb
+- lib/under_os/http/session.rb
+- spec/core/hash_spec.rb
+- spec/core/string_spec.rb
+- spec/under_os/http/cookies_spec.rb
+- spec/under_os/http/request_spec.rb
+- spec/under_os/http_spec.rb
+- under-os-http.gemspec
+homepage: http://under-os.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: The HTTP stack for the UnderOs project. Summaries FTW
+test_files:
+- spec/core/hash_spec.rb
+- spec/core/string_spec.rb
+- spec/under_os/http/cookies_spec.rb
+- spec/under_os/http/request_spec.rb
+- spec/under_os/http_spec.rb