Merge pull request #90 from lohanidamodar/feat-ruby-sdk-upload-support

Feature Ruby SDK upload support

Author: eldadfux

src/SDK/Language/Ruby.php

@@ -130,6 +130,12 @@ public function getFiles()
                 'template'      => '/ruby/lib/container/service.rb.twig',
                 'minify'        => false,
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'lib/{{ spec.title | caseDash }}/file.rb',
+                'template'      => '/ruby/lib/container/file.rb.twig',
+                'minify'        => false,
+            ],
             [
                 'scope'         => 'service',
                 'destination'   => '/lib/{{ spec.title | caseDash}}/services/{{service.name | caseDash}}.rb',

templates/ruby/Gemfile.twig

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 
+gem 'mime-types', '~> 3.1'
 gemspec

templates/ruby/docs/example.md.twig

@@ -12,6 +12,6 @@ client
 
 {{ service.name | caseSnake }} = {{spec.title | caseUcfirst}}::{{ service.name | caseUcfirst }}.new(client);
 
-response = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{parameter.name|caseSnake}}: {{ parameter | paramExample }}{% endif %}{% endfor %});
+response = {{ service.name | caseSnake }}.{{ method.name | caseSnake }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{parameter.name|caseSnake}}: {% if parameter | paramExample == "File.new()" %}{{spec.title | caseUcfirst}}::{{ parameter | paramExample }}{% else %}{{ parameter | paramExample }}{% endif %}{% endif %}{% endfor %});
 
 puts response

templates/ruby/lib/container.rb.twig

@@ -1,8 +1,10 @@
 require 'net/http'
 require 'uri'
 require 'json'
+require 'mime/types'
 require_relative '{{ spec.title | caseDash }}/client'
 require_relative '{{ spec.title | caseDash }}/service'
+require_relative '{{ spec.title | caseDash }}/file'
 {% for service in spec.services %}
 require_relative '{{ spec.title | caseDash }}/services/{{ service.name | caseDash }}'
 {% endfor %}

templates/ruby/lib/container/client.rb.twig

@@ -67,11 +67,14 @@ module {{spec.title | caseUcfirst}}
             payload = ''
 
             headers = @headers.merge(headers)
-
+            @BOUNDARY = "----A30#3ad1"
             if (method != METHOD_GET)
                 case headers['content-type'][0, headers['content-type'].index(';') || headers['content-type'].length]
                     when 'application/json'
                         payload = params.to_json
+                    when 'multipart/form-data'
+                        payload = "--#{@BOUNDARY}\r\n" + encodeFormData(params)
+                        headers['content-type'] = "multipart/form-data; boundary=#{@BOUNDARY}"
                     else
                         payload = encode(params)
                 end
@@ -93,6 +96,27 @@ module {{spec.title | caseUcfirst}}
 
             return JSON.parse(response.body);
         end
+        
+        def encodeFormData(value, key=nil)
+            case value
+            when Hash  then value.map { |k,v| encodeFormData(v,k) }.join
+            when Array then value.map { |v| encodeFormData(v, "#{key}[]") }.join
+            when nil   then ''
+            else
+                post_body = []
+                if(value.instance_of? File)
+                    post_body << "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{value.name}\"\r\n"
+                    post_body << "Content-Type: #{value.mimeType}\r\n\r\n"
+                    post_body << value.content
+                    post_body << "\r\n--#{@BOUNDARY}--\r\n"
+                else          
+                    post_body << "Content-Disposition: form-data; name=\"#{key}\"\r\n\r\n"
+                    post_body << "#{value.to_s}" 
+                    post_body << "\r\n--#{@BOUNDARY}\r\n"
+                end
+                post_body.join
+            end
+        end
 
         def encode(value, key = nil)
             case value

templates/ruby/lib/container/file.rb.twig

@@ -0,0 +1,23 @@
+require 'mime/types'
+
+module {{spec.title | caseUcfirst}}
+    class File
+        def initialize(path)
+            @name = ::File.basename(path)
+            @content = ::File.read(path)
+            @mimeType = MIME::Types.type_for(path)
+        end
+
+        def name
+            @name
+        end
+
+        def content
+            @content
+        end
+
+        def mimeType
+            @mimeType
+        end
+    end
+end

tests/SDKTest.php

@@ -124,15 +124,16 @@ class SDKTest extends TestCase
         'ruby' => [
             'class' => 'Appwrite\SDK\Language\Ruby',
             'build' => [
+                'docker run --rm -v $(pwd):/app -w /app/tests/sdks/ruby --env GEM_HOME=/app/vendor ruby:2.7-alpine sh -c "apk add git build-base && bundle install"'
             ],
             'envs' => [
-                'ruby-2.7' => 'docker run --rm -v $(pwd):/app -w /app ruby:2.7-alpine ruby tests/languages/ruby/tests.rb',
-                'ruby-2.6' => 'docker run --rm -v $(pwd):/app -w /app ruby:2.6-alpine ruby tests/languages/ruby/tests.rb',
-                'ruby-2.5' => 'docker run --rm -v $(pwd):/app -w /app ruby:2.5-alpine ruby tests/languages/ruby/tests.rb',
-                'ruby-2.4' => 'docker run --rm -v $(pwd):/app -w /app ruby:2.4-alpine ruby tests/languages/ruby/tests.rb',
+                'ruby-2.7' => 'docker run --rm -v $(pwd):/app -w /app --env GEM_HOME=vendor ruby:2.7-alpine ruby tests/languages/ruby/tests.rb',
+                'ruby-2.6' => 'docker run --rm -v $(pwd):/app -w /app --env GEM_HOME=vendor ruby:2.6-alpine ruby tests/languages/ruby/tests.rb',
+                'ruby-2.5' => 'docker run --rm -v $(pwd):/app -w /app --env GEM_HOME=vendor ruby:2.5-alpine ruby tests/languages/ruby/tests.rb',
+                'ruby-2.4' => 'docker run --rm -v $(pwd):/app -w /app --env GEM_HOME=vendor ruby:2.4-alpine ruby tests/languages/ruby/tests.rb',
             ],
             'supportRedirect' => true,
-            'supportUpload' => false,
+            'supportUpload' => true,
         ],
 
         'python' => [
@@ -184,7 +185,6 @@ public function testHTTPSuccess()
         }
 
         $whitelist = ['php', 'java', 'node', 'ruby', 'python', 'typescript', 'deno', 'dotnet', 'dart'];
-
         foreach ($this->languages as $language => $options) {
             if(!empty($whitelist) && !in_array($language, $whitelist)) {
                 continue;
@@ -228,7 +228,6 @@ public function testHTTPSuccess()
                     }
                 }
             }
-
             /**
              * Run tests on all different envs
              */

tests/languages/ruby/tests.rb

@@ -45,3 +45,8 @@
 
 response = general.redirect();
 puts response['result']
+
+
+file = Appwrite::File.new('./tests/resources/file.png')
+response = general.upload(x:'string',y: 123,z:['string in array'], file: file);
+puts response['result']