smartfile 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18bcc55819ada207ddc3bc621a1a185e476d9c79
+  data.tar.gz: f0975b81b82bd630a42f3d1a07d111dec3c11aff
+SHA512:
+  metadata.gz: c5f2eb5713c3045d416604131780b456dbe2c48dbaca0b6647f3b71c3a1a6112e3e107fee53eb2c3ec90afc6033a98ab03f2bfdc551cc930f40212643cc821c4
+  data.tar.gz: 98c92faa203395f58934f09e7c03c213cb14ef2794da5ee66e29c1a8114315153dd732840269e22229547b58d3072407263f433cf55fc685760bd3c59ac1c398

data/CHANGELOG.md

@@ -0,0 +1 @@
+3/22/14 1:12am - Initial Version

data/README.md

@@ -0,0 +1,74 @@
+# SmartFile
+
+A ruby client wrapper for the [SmartFile](http://smartfile.com) file platform.
+SmartFile has free developer accounts with 1 user, 100GB storage, and 200GB monthly transfer!
+
+Works with Ruby 1.9 and likely 2.0 (Has not been tested)
+This is an early version and the interface might change so use at your own risk.
+As of version 0.1, only whoami and ping paths have been tested! I added some others to play around with for the next gem version.
+
+## API Paths Currently Implemented
+
+  - Path - Info, as :path_info
+  - Path - Data, as :path_data
+  - Path - Search, as :path_search
+  - Ping, as :ping
+  - Whoami, as :whoami
+  - Session, as :session
+
+## Setup:
+
+Instructions assume you are using Rails, but Rails is not required. 
+
+Create the file config/smartfile.yml:
+
+    key: your smartfile apikey here
+    pass: your smartfile password here
+
+Create the file config/initializers:
+
+    api_config_path = "#{Rails.root}/config/smartfile.yml"
+    if File.exists?(api_config_path)
+      SMARTFILE_CONFIG = YAML.load_file(api_config_path)
+    end
+
+## Usage:
+
+    call = SmartFile.new
+    params = {:attribute => "query"}
+    call.setup(:whoami, format = "json")
+    
+    # regular get
+    result = call.get(params)
+    
+    # regular post
+    result = call.post(params)
+    
+    # get or post with full response object
+    result = call.get(params, true)
+    puts result
+    => "#<Net::HTTPOK 200 OK readbody=true>"
+    puts result.body
+    '{"ping": "pong"}'
+
+
+## Valid Return Formats: 
+  - json
+  - json-p
+  - json-t
+  - html
+  - xhtml
+  - txt 
+  - xml
+
+## (Optional) Use [Nokogiri](http://nokogiri.org/) to parse XML formatted results:
+
+    doc = Nokogiri::XML(result.body)
+
+Then, to search for nodes existing in the result body by XML node name:
+
+    full_node = doc.css('nodeName')
+
+To get the value of a node:
+
+    attr = doc.search('attr').text

data/ROADMAP.md

@@ -0,0 +1,9 @@
+TODO:
+
+Implement and test all the endpoints.
+
+Add a Dropbox-like folder synchronization feature
+
+??? 
+
+Profit

data/lib/init.rb

@@ -0,0 +1 @@
+require 'smartfile'

data/lib/smartfile.rb

@@ -0,0 +1,82 @@
+require "net/https"
+require "uri"
+require "yaml"
+
+
+class SmartFile
+
+  attr_accessor :key, :pass
+  attr_accessor :base_url, :service_path
+  attr_accessor :response, :json_response
+
+  def initialize()
+    @key = SMARTFILE_CONFIG['key']
+    @pass = SMARTFILE_CONFIG['pass']
+    @base_url = "https://app.smartfile.com/api/2"
+    @service_path = ""
+  end
+
+  def full_url
+    @base_url + @service_path
+  end
+
+  # valid formats - [json] [json-p] [json-t] [html] [xhtml] [txt] [xml]
+  def setup(endpoint, format = "json")
+    case endpoint
+      when :path_info
+        @service_path = "/ping/?format=#{format}"
+      when :path_data
+        @service_path = "/whoami/?format=#{format}"
+      when :session
+        @service_path = "/session/?format=#{format}"
+      when :ping
+        @service_path = "/ping/?format=#{format}"
+      when :whoami
+        @service_path = "/whoami/?format=#{format}"
+      when :session
+        @service_path = "/session/?format=#{format}"  
+    end
+  end
+
+  def get(params = {}, full_response = false)
+    uri = URI.parse(full_url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    # VERIFY_NONE is not ideal for security, but its a risk I'm willing to take.
+    # For the paranoid if you want to add cert bundles to your server you can fix it:
+    # http://www.rubyinside.com/how-to-cure-nethttps-risky-default-https-behavior-4010.html
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    @request = Net::HTTP::Get.new(uri.request_uri)
+    @request.basic_auth(@key, @pass)
+    @request["User-Agent"] = "smartfile_rubygem_1.0"
+    @response = http.request(@request)
+    
+    if full_response
+      return @response
+    else
+      return @response.body
+    end
+  end
+
+  def post(params = {}, full_response = false)
+    uri = URI.parse(full_url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    # VERIFY_NONE is not ideal for security, but its a risk I'm willing to take.
+    # For the paranoid if you want to add cert bundles to your server you can fix it:
+    # http://www.rubyinside.com/how-to-cure-nethttps-risky-default-https-behavior-4010.html
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    @request = Net::HTTP::Post.new(uri.request_uri)
+    @request.basic_auth(@key, @pass)
+    @request.set_form_data(params)
+    @response = http.request(@request)
+    
+    if full_response
+      return @response
+    else
+      return @response.body
+    end
+  end
+
+
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: smartfile
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Ryan L. Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Easily use the SmartFile APIs within your ruby or rails project.
+email:
+- rjs6143@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/smartfile.rb
+- lib/init.rb
+- README.md
+- ROADMAP.md
+- CHANGELOG.md
+homepage: http://ryanjohnson.mobi
+licenses: []
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: SmartFile API Wrapper
+test_files: []
+has_rdoc: