motion_ocean 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb14f92dec01163395d43525ad7e66664ff2e796
-  data.tar.gz: 3ca20c500add45aacc4bb2c358276bca28461d0e
+  metadata.gz: 8e8d553b93122e2453a621d617a90831ec6e225d
+  data.tar.gz: ca435978b2a0e40383976aa343297413c49d80d4
 SHA512:
-  metadata.gz: 0deb674b9e246ba6b9a5584cbf65ff19ceea0577892fb197390837534f27b697a9a9d7396e784447dbc1d04b13cf6fbc906c6360d701e034b7ef41e53d0cd2a6
-  data.tar.gz: 7be9fba616e5fe10e218ba2330e6e64d75b60f4cd35538a2ffcaa50827b9b16c18cc4e3eb898f71218674d1b40b2814c06788b3bbb68814dc792d88c6d91a1fb
+  metadata.gz: aabec4b730b1aa08865c0e844eda3521f0d72781814479ffebde1c0ce0334568bb2e722998489d5a32d63c488d10a6da6783d7d144d0b41d62e73702b8945123
+  data.tar.gz: de1257b71353f6f6a278d04a0b9ca68d779857166e133801fd81360878fa49c713d32a8a12baaaff77b695825fc1bbb5bddd68504cc36f437ae44ba90854d384

data/README.md

@@ -42,11 +42,13 @@ end
 
 ### Usage
 
-Since MotionOcean is based on [AFMotion][afmotion], requests are being made asynchronous. Every MotionOcean method call therefore requires a block, which yields the data (or nil if the request failed).
+The API client is based on NSURLSession and every request is executed asynchronously. Every MotionOcean method call therefore requires a block, which yields a `MotionOcean::API::Response`.
 
 MotionOcean pretty much implements the DO API 1:1, so please check [their documentation](https://developers.digitalocean.com/v2/) for the available functions and options.
 
-### success?
+### The response object
+
+#### success?
 
 You can use `success?` to check if a successful HTTP status code was returned:
 
@@ -56,25 +58,41 @@ client.droplet.create(options) do |result|
 end
 ```
 
-### response
+#### data
+
+The response data is assigned to the `data`-property of the response object. This is a `Hash` which 
+corresponds with the returned JSON by DigitalOcean.
 
-MotionOcean uses [AFMotion][afmotion]. You can use `response` to get to the response
+``` ruby
+client.droplet.create(options) do |result|
+  result.data # => Hash with the JSON response
+end
+```
+
+
+#### response
+
+MotionOcean uses NSURLSession. You can use `response` to get to the original response
 object:
 
 ``` ruby
 client.droplet.create(options) do |result|
-  result.response # => AFMotion::HTTPResult
+  result.response # => NSHTTPURLResponse
 end
 ```
-[afmotion]: https://github.com/usepropellor/afmotion
+#### error
+
+When there is an error you can check this for the specific error. If you think it is a bug in MotionOcean, please open an issue or even better: submit a Pull Request with the fix!
 
 ## Aknowledgements
 
 This library is an adaptation for RubyMotion of [barge](https://github.com/boats/barge) by [Ørjan Blom](https://github.com/blom). 
 
+The brilliant [MotionInMotion](https://motioninmotion.tv) screencasts helped me with implementing the API client using NSURLSession (specifically [episode #33](https://motioninmotion.tv/screencasts/33)) and iOS development using RubyMotion in general.
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/motion_ocean/fork )
+1. Fork it ( https://github.com/datarift/motion_ocean/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/motion_ocean.rb

@@ -1,5 +1,4 @@
 require 'dbt'
-require 'afmotion'
 
 unless defined?(Motion::Project::Config)
   raise "This file must be required within a RubyMotion project Rakefile."

data/lib/motion_ocean/api.rb

@@ -0,0 +1,5 @@
+module MotionOcean
+  module API
+    
+  end
+end

data/lib/motion_ocean/api/authorization.rb

@@ -0,0 +1,30 @@
+module MotionOcean
+  module API
+    class Authorization
+      class << self
+        def build(options = {})
+          username, password = options.values_at :username, :password
+          token = options.fetch(:token, nil)
+          token_name = options.fetch(:token_name, "Token")
+      
+          if username && password
+            http_basic_header(username, password)
+          elsif token
+            token_header(token, token_name)
+          else
+            nil
+          end
+        end
+    
+        def http_basic_header(username, password)
+          token_data = "#{username}:#{password}".dataUsingEncoding(NSUTF8StringEncoding)
+          token_header(token_data.base64Encoding, "Basic")
+        end
+        
+        def token_header(token, token_name)
+          "#{token_name} #{token}"
+        end
+      end
+    end    
+  end
+end

data/lib/motion_ocean/api/client.rb

@@ -0,0 +1,115 @@
+module MotionOcean
+  module API
+    class Client
+      attr_reader :base_url
+      
+      def initialize(base_url, &block)
+        base_url += '/' unless base_url.end_with? '/'
+        @base_url = NSURL.URLWithString(base_url)
+        @headers = {}
+      
+        # yield(self) if block_given?
+        if block_given?
+          case block.arity
+          when 0
+            instance_eval(&block)
+          when 1
+            block.call(self)
+          end
+        end
+      end
+      
+      [:delete, :get, :head, :post, :put].each do |verb|
+        define_method verb do |path, options = {}, &block|
+          request = create_request(path, options, verb)
+          create_task(request, &block).resume
+        end
+      end
+      
+      def header(name, value)
+        @headers[name] = value
+      end
+    
+      def authorization(options = {})
+        header "Authorization", MotionOcean::API::Authorization.build(options)
+      end
+    
+      private
+      def config
+        NSURLSessionConfiguration.defaultSessionConfiguration
+      end
+    
+      def session
+        NSURLSession.sessionWithConfiguration(config)
+      end
+    
+      def create_request(path, options, method)
+        headers = options.fetch(:headers, {})
+        body = options.fetch(:body, nil)
+        query = options.fetch(:query, nil)
+
+        url = create_url(path, query)
+        
+        request = NSMutableURLRequest.requestWithURL(url)
+        
+        set_headers(request, @headers.merge(headers))
+        set_body(request, body) if body
+        
+        request.setHTTPMethod(method.to_s.upcase)
+        
+        request
+      end
+      
+      def create_url(path, query)
+        query_string = query.map { |key, value| "#{key}=#{value}" }.join '&' unless query.nil?
+        
+        path.sub!('/', '') if path.start_with? '/'
+        
+        components = NSURLComponents.new
+        components.path = path
+        components.query = query_string
+        components.URLRelativeToURL @base_url
+      end
+      
+      def set_headers(request, headers)
+        headers.each do |name, value|
+          request.addValue value.to_s, forHTTPHeaderField: name.to_s
+        end
+      end
+      
+      def set_body(request, params)
+        data = json_params(params)
+        request.setHTTPBody(data)
+      end
+      
+      def json_params(params)
+        NSJSONSerialization.dataWithJSONObject(params, options: 0, error: nil)
+      end
+      
+      def create_task(request, &block)
+        if block_given?
+          session.dataTaskWithRequest(request, completionHandler: -> (data, response, error) {
+            block.call(APIResponse.new(data, response, error))
+          })
+        else
+          session.dataTaskWithRequest(request)
+        end
+      end
+      
+      class APIResponse
+        attr_reader :success, :data, :error, :response
+
+        def initialize(data, response, error)
+          @success = (200...300).include?(response.statusCode) if response
+          @data = NSJSONSerialization.JSONObjectWithData(data, options: 0, error: nil)
+          @response = response
+          @error = error
+        end
+
+        def success?
+          @success
+        end
+      end
+    end
+  end
+end

data/lib/motion_ocean/client.rb

@@ -25,20 +25,18 @@ module MotionOcean
       @action  = Resource::Action.new(api_client)
       @domain  = Resource::Domain.new(api_client)
       @droplet = Resource::Droplet.new(api_client)
+      @image   = Resource::Image.new(api_client)
+      @key     = Resource::Key.new(api_client)
       @region  = Resource::Region.new(api_client)
       @size    = Resource::Size.new(api_client)
     end
     
     def api_client
-      @api_client ||= AFMotion::SessionClient.build(DIGITAL_OCEAN_URL) do |client|
-        client.session_configuration :default
-        
+      @api_client ||= MotionOcean::API::Client.new(DIGITAL_OCEAN_URL) do |client|
         client.header 'Accept', 'application/json'
         client.header 'Content-Type', 'application/json'
-        client.header 'Authorization', "Bearer #{access_token}"
         
-        client.request_serializer :json
-        client.response_serializer :json
+        client.authorization token: access_token, token_name: 'Bearer'
       end
     end
   end

data/lib/motion_ocean/resource/base.rb

@@ -21,13 +21,7 @@ module MotionOcean
         opts = { per_page: PER_PAGE } if verb == :get
         options = opts.merge(options)
         
-        api_client.public_send(verb, url, options) do |response|
-          data = response.object.tap do |r|
-            r.define_singleton_method(:response) { response }
-            r.define_singleton_method(:success?) { response.success? }
-          end
-          block.call(data)
-        end
+        api_client.public_send(verb, url, options, &block)
       end
     end
   end

data/lib/motion_ocean/version.rb

@@ -1,3 +1,3 @@
 module MotionOcean
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/spec/api/authorization_spec.rb

@@ -0,0 +1,27 @@
+describe "MotionOcean::API::Authorization" do
+  before do
+    @token = 'some_token'
+    @token_name = 'FooBar'
+    @username = 'foo'
+    @password = 'bar'
+    @auth_data = 'Zm9vOmJhcg=='
+  end
+  
+  it "creates a token-based auth header" do
+    header_value = MotionOcean::API::Authorization.build(token: @token)
+    
+    header_value.should == "Token #{@token}"
+  end
+  
+  it "uses the specified token_name" do
+    header_value = MotionOcean::API::Authorization.build(token: @token, token_name: @token_name)
+    
+    header_value.should == "#{@token_name} #{@token}"
+  end
+  
+  it "accepts HTTP Basic parameters" do
+    header_value = MotionOcean::API::Authorization.build(username: @username, password: @password)
+    
+    header_value.should == "Basic #{@auth_data}"
+  end
+end

data/spec/api/client_spec.rb

@@ -0,0 +1,53 @@
+describe "MotionOcean::API::Client" do
+  before do
+    @base_url = 'http://httpbin.org/'
+    @base_url_no_slash = 'http://httpbin.org'
+    @token = 'some_test_token'
+  end
+  
+  it "accepts a base URL and a block" do
+    client = MotionOcean::API::Client.new(@base_url) do
+      
+    end
+    
+    client.base_url.should != nil
+    client.base_url.absoluteString.should == @base_url
+  end
+  
+  it "adds a slash to the base_url if it is not present" do
+    client = MotionOcean::API::Client.new(@base_url_no_slash) do
+      
+    end
+    
+    client.base_url.should != nil
+    client.base_url.absoluteString.should == @base_url
+  end
+  
+  it "accepts headers" do
+    client = MotionOcean::API::Client.new(@base_url_no_slash) do
+      header 'Accept', 'application/json'
+    end
+    
+    headers = client.instance_variable_get(:@headers)
+    
+    headers.should != nil
+    headers.empty?.should == false
+    headers.should.be.kind_of Hash
+    headers.include?('Accept').should == true
+    headers['Accept'].should == 'application/json'
+  end
+  
+  it "sets authorization headers" do
+    client = MotionOcean::API::Client.new(@base_url_no_slash) do
+      authorization token: 'some_test_token'
+    end
+    
+    headers = client.instance_variable_get(:@headers)
+    
+    headers.should != nil
+    headers.empty?.should == false
+    
+    headers.include?('Authorization').should == true
+    headers['Authorization'].should == "Token #{@token}"
+  end
+end

data/spec/client_spec.rb

@@ -1,9 +1,16 @@
 describe "MotionOcean::Client" do
-  describe "#access_token" do
-    before do
-      @token ||= "some_token"
-    end
+  before do
+    @token ||= "some_token"
+  end
   
+  describe "class" do
+    it "is the right class" do
+      client = MotionOcean::Client.new(access_token: @token)
+      client.should.be.kind_of(MotionOcean::Client)
+    end
+  end
+
+  describe "#access_token" do
     it "can be set via a hash" do
       client = MotionOcean::Client.new(access_token: @token)
       expect(client.access_token).to eq(@token)
@@ -24,4 +31,22 @@ describe "MotionOcean::Client" do
     end
     
   end
+  
+  describe "operation" do
+    it "can call the API" do
+      client = MotionOcean::Client.new(access_token: ENV['DO_API_TOKEN'])
+      client.should != nil
+    
+      client.domain.all do |response|
+        expect(response).not_to be_nil
+        expect(response.success?).to be_true
+        expect(response.error).to be_nil
+        response.data.should.be.kind_of(Hash)
+      
+        resume
+      end
+    
+      wait_max(10) {}
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion_ocean
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Erwin Boskma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dbt
@@ -30,26 +30,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: afmotion
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +100,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/motion_ocean.rb
+- lib/motion_ocean/api.rb
+- lib/motion_ocean/api/authorization.rb
+- lib/motion_ocean/api/client.rb
 - lib/motion_ocean/client.rb
 - lib/motion_ocean/resource/action.rb
 - lib/motion_ocean/resource/base.rb
@@ -130,6 +113,8 @@ files:
 - lib/motion_ocean/resource/region.rb
 - lib/motion_ocean/resource/size.rb
 - lib/motion_ocean/version.rb
+- spec/api/authorization_spec.rb
+- spec/api/client_spec.rb
 - spec/client_spec.rb
 homepage: https://github.com/datarift/motion_ocean
 licenses:
@@ -156,4 +141,6 @@ signing_key:
 specification_version: 4
 summary: Digital Ocean API implementation for RubyMotion
 test_files:
+- spec/api/authorization_spec.rb
+- spec/api/client_spec.rb
 - spec/client_spec.rb