upscrn-client 0.1.1 → 0.2.0

data/README.mdown

@@ -5,22 +5,144 @@ This is a client for the [upscrn](http://upscrn.com) api.
 
 ## Usage
 
+====== OLD VERSION (before 0.2.0)======
 Get the api token from upscrn.com.
 
-Upload a screenshot with: 
+Upload a screenshot with:
+
+    Upscrn::Client.upload_screenshot(filename, auth_token)
 
-    UpscrnClient::Client.upload_screenshot(filename, auth_token) 
-    
 To upload a screenshot to a specific project, use:
 
-    UpscrnClient::Client.upload_screenshot(filename, auth_token, :project_id => 12345)
-    
+    Upscrn::Client.upload_screenshot(filename, auth_token, :project_id => 12345)
+
 For a list of a user's projects, use:
 
-     UpscrnClient::Client.projects(auth_token)
+     Upscrn::Client.projects(auth_token)
+
+
+====== NEW VERSION (since 0.2.0) ======
+
+### How To use
+
+You can set the auth token in two ways
+
+Config:
+
+    Upscrn::Client.config do |config|
+      config.auth_token = 'your_auth_token'
+    end
+
+Initialization:
+
+    client = Upscrn::Client.new('your_auth_token')
+
+
+### Projects:
+  
+List all projects:
+
+    client.projects(:all => true).get
+
+    client.projects(:page => 2).get
+  
+Get a project:
+
+    client.project(project_id).get
+
+Create a project:
+    
+    client.projects(:project => {:name => 'test'}).post
+
+Edit a project:
+    
+    client.projects(project_id , :project => {:name => 'edited'}).put
+
+### Screenshots:
+
+List all Screeshots
+
+    client.screenshots(:all => true).get
+    client.screenshots(:page => 2).get
+
+List all Screeshots in a Project
+    
+    client.project(project_id).screenshots(:all => true).get
+    client.project(project_id).screenshots(:page => 2).get
+
+Create a Screenshot:
+
+    client.screenshots(:screenshot => {:image => File.open('path/to/image')}).get
+
+Create a Screenshot in a Project:
+
+    client.project(project_id).screenshots(:screenshot => {:title => 'title',:image => File.open('path/to/image')}).post
+
+Get a Screenshot
+
+    client.screenshot(screenshot_id).get
+    client.project(project_id).screenshot(screenshot_id).get
+
+Create a Comment on a screenshot
+
+    client.project(project_id).screenshot(screenshot_id).comment(:comment => {:body => 'comment'}).post
+
+List all comments on a screenshot
+
+    client.project(project_id).screenshot(screenshot_id).comments.post
+
+List all versions on a screenshot
+
+    client.project(project_id).screenshot(screenshot_id).versions.post
+
+Create a Version on a screenshot
+
+    client.project(project_id).screenshot(screenshot_id).version(:screenshot => {:title => 'title',:image => File.open('path/to/image')}).post
+
+### Videos:
+
+List all Videos
+
+    client.videos(:all => true).get
+    client.videos(:page => 2).get
+
+List all Videos in a Project
+
+    client.project(project_id).videos(:all => true).get
+    client.project(project_id).videos(:page => 2).get
+
+Create a Video:
+
+    client.videos(:video => {:image => File.open('path/to/image')}).get
+
+Create a Video in a Project:
+
+    client.project(project_id).videos(:video => {:title => 'title',:file => File.open('path/to/image')}).post
+
+Get a Video
+
+    client.video(video_id).get
+    client.project(project_id).video(video_id).get
+
+Create a Comment on a Video
+
+    client.project(project_id).video(video_id).comment(:comment => {:body => 'comment'}).post
+
+List all comments on a Video
+
+    client.project(project_id).video(video_id).comments.post
+
+List all versions on a Video
+
+    client.project(project_id).video(video_id).versions.post
+
+Create a Version on a Video
+
+    client.project(project_id).video(video_id).version(:video => {:title => 'title',:file => File.open('path/to/image')}).post
+
 
 ## Contributing to upscrn-client
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project

data/VERSION

@@ -1 +1,2 @@
-0.1.1
+0.2.0
+

data/lib/upscrn-client.rb

@@ -1,8 +1,9 @@
 require 'rubygems'
 require 'bundler/setup'
-require 'json'
+require 'json/pure'
 require 'rest_client'
 require File.dirname(__FILE__) + '/upscrn_client/client'
 
-module UpscrnClient
-end
+module Upscrn
+end
+

data/lib/upscrn_client/client.rb

@@ -1,13 +1,22 @@
-module UpscrnClient
+module Upscrn
   class Client
     class << self
 
-      
-      # Upload a screenshot to the upscrn server. 
+       attr_accessor :auth_token
+
+       def config
+         yield self
+       end
+
+
+      #### WARNING: THE CLASS METHODS ARE DEPRECATED
+
+       # Upload a screenshot to the upscrn server.
       # Pass :project_id in the options to upload to a particular project
-      
+
       def upload_screenshot(filename, auth_token, options = {})
-        puts "filepath: #{filepath}"
+        puts "DEPRECATED: will be removed on version 0.3"
+        #puts "filepath: #{filepath}"
         @result = Hash.new
         @result['success'] = true
         file = File.open filename, 'r'
@@ -17,42 +26,148 @@ module UpscrnClient
           else
             post_response = perform('post', 'screenshots', auth_token, {:screenshot => {:image => file}})
           end
-  
-          puts "response: #{post_response}"
+
+          #puts "response: #{post_response}"
           @url = post_response["url"]
           @result['success'] = true
           @result['url'] = @url
-          #clickable_link = NSAttributedString.hyperlinkFromString("See on upscrn", withURL:nsurl)
-          puts "url = #{@url}"
-          #@url_label.stringValue = nsurl
-          #show_screenshot_url(@url, nsurl)
+          #puts "url = #{@url}"
           @url
         rescue Exception => e
-          puts "Exception!  #{e.message}"
+          #puts "Exception!  #{e.message}"
           @result['success'] = false
-          puts "1"
           @result['error'] = e.message.to_s
-          puts "set result"
-          #@url_label.stringValue = e.message
         end
         @result
       end
-        
-      
+
+
       # return a list of projects for a given user
-      # list is returned in json format  
+      # list is returned in json format
       def projects(auth_token)
+        puts "DEPRECATED: will be removed on version 0.3"
         perform('get', 'projects', auth_token)
       end
 
+      private
+
       def perform(verb,action,auth_token, params={})
         action = [action, 'json'].join('.')
         url = ['http://upscrn.com', action].join('/')
-        #url = ['http://127.0.0.1:3000', action].join('/')
         url = url + "?auth_token=#{auth_token}"
-        #p url
         JSON.parse(RestClient.send(verb,url,params).body)
       end
+
+    end
+
+    attr_accessor :auth_token , :resources , :params
+
+
+
+    def initialize(auth_token = nil)
+      @auth_token = auth_token || self.class.auth_token
+      @resources = []
+      @params = {}
+    end
+
+
+    def projects(params = {})
+       tap do
+         @resources = ['projects']
+         @params.merge!(params)
+       end
+    end
+
+    def screenshots(params = {})
+       tap do
+         @resources += ['screenshots']
+         @params.merge!(params)
+       end
+    end
+
+    def comments(params = {})
+       tap do
+         @resources += ['comments']
+         @params.merge!(params)
+       end
+    end
+
+    def videos(params = {})
+       tap do
+         @resources += ['videos']
+         @params.merge!(params)
+       end
+    end
+
+    def project(id , params = {})
+      tap do
+        @resources = ['projects',id]
+        @params.merge!(params)
+      end
     end
+
+    def screenshot(id , params = {})
+      tap do
+        @resources += ['screenshots',id]
+        @params.merge!(params)
+      end
+    end
+
+    def video(id , params = {})
+      tap do
+        @resources += ['videos',id]
+        @params.merge!(params)
+      end
+    end
+
+    def comment(params = {})
+      tap do
+        @resources += ['comments']
+        @params.merge!(params)
+      end
+    end
+
+
+
+    def get(clean = true)
+      result = client[build_path(@auth_token,@resources,@params)].get
+      self.clean if clean
+      JSON.parse result
+    end
+
+    def post(clean = true)
+      result = client[build_path(@auth_token,@resources)].post(@params)
+      self.clean if clean
+      JSON.parse result
+    end
+
+    def put(clean = true)
+      result = client[build_path(@auth_token,@resources)].put(@params)
+      self.clean if clean
+      JSON.parse result
+    end
+
+    def clean
+      tap do
+        @resources = []
+        @params = {}
+      end
+    end
+
+    private
+
+    def client
+      @client ||= RestClient::Resource.new('http://upscrn.com')
+    end
+
+    def build_path(auth_token,resources , params = {})
+      url = resources.join('/')
+      url += '.json'
+      url += "?" + params.merge(:auth_token => auth_token).to_a.map{|p| p.join('=')}.join('&')
+      puts "Path built: #{url}"
+      URI.encode(url)
+    end
+
   end
-end
+end
+

data/upscrn-client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{upscrn-client}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Matt Cowley}]
-  s.date = %q{2011-09-22}
+  s.date = %q{2011-10-10}
   s.description = %q{client library for accessing the upscrn api}
   s.email = %q{madcowley@gmail.com}
   s.extra_rdoc_files = [
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{https://github.com/Yeti-Media/upscrn-client}
   s.licenses = [%q{MIT}]
   s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.8}
+  s.rubygems_version = %q{1.8.5}
   s.summary = %q{client library for accessing the upscrn api}
 
   if s.respond_to? :specification_version then

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: upscrn-client
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Matt Cowley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-22 00:00:00 Z
+date: 2011-10-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -27,10 +27,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rest-client
-  prerelease: false
   type: :runtime
   requirement: *id001
+  prerelease: false
+  name: rest-client
 - !ruby/object:Gem::Dependency 
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -41,10 +41,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: json_pure
-  prerelease: false
   type: :runtime
   requirement: *id002
+  prerelease: false
+  name: json_pure
 - !ruby/object:Gem::Dependency 
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -57,10 +57,10 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
-  name: rspec
-  prerelease: false
   type: :development
   requirement: *id003
+  prerelease: false
+  name: rspec
 - !ruby/object:Gem::Dependency 
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -73,10 +73,10 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  name: bundler
-  prerelease: false
   type: :development
   requirement: *id004
+  prerelease: false
+  name: bundler
 - !ruby/object:Gem::Dependency 
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -89,10 +89,10 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  name: jeweler
-  prerelease: false
   type: :development
   requirement: *id005
+  prerelease: false
+  name: jeweler
 - !ruby/object:Gem::Dependency 
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -103,10 +103,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rcov
-  prerelease: false
   type: :development
   requirement: *id006
+  prerelease: false
+  name: rcov
 description: client library for accessing the upscrn api
 email: madcowley@gmail.com
 executables: []
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: client library for accessing the upscrn api