crate_api 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Brian Michel
+
+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/README.md

@@ -0,0 +1,52 @@
+Crate API
+----------
+
+This is a light ruby wrapper for the Crate filesharing API
+
+Contributing to Crate API
+-------------------------
+ 
+* You know the drill, fork, change, pull request if you so like!
+
+Things undone
+-------------
+
+* The file part of the api is as of yet undone.
+* Proper documentation which I'll be doing soon
+* Tests to verify that everything is working
+* There is probably some weirdness with the exception handling, will take another look
+
+Usage
+-----
+ Require
+
+    require 'crate_api'
+ Create a client!
+
+    client = CrateAPI.new("username", "password")
+ Get some crates!
+
+    crates = client.crates.all
+ Look at their files!
+
+    crates[0].files
+ All crate and item object support getting their short url so...
+
+    crates[0].short_url || crates[0].files[0].short_url
+ Add a file to a crate!
+
+    crates[0].add_file("/path/to/your/file")
+ Destroy a crate or file!
+
+    crates[0].destroy - NOTE: this will destroy all of the files contained within without warning
+    crates[0].files[0].destroy
+ Add a crate!
+
+    client.crates.add("NameOfYourAwesomeCrate")
+ That's about it for now!
+
+Copyright
+---------
+
+Copyright (c) 2011 Brian Michel. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "crate_api"
+  gem.homepage = "http://github.com/brianmichel/crate_api"
+  gem.license = "MIT"
+  gem.summary = %Q{Interface with the Crate API}
+  gem.description = %Q{This gem will allow for easy interaction with the Crate API to share your files!}
+  gem.email = "brian.michel@gmail.com"
+  gem.authors = ["Brian Michel"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_runtime_dependency 'httmultiparty', '>= 0.3.0'
+  gem.add_runtime_dependency 'json', '>= 1.5.1'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "crate_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/crate_api.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{crate_api}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Michel"]
+  s.date = %q{2011-04-23}
+  s.description = %q{This gem will allow for easy interaction with the Crate API to share your files!}
+  s.email = %q{brian.michel@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "crate_api.gemspec",
+    "lib/crate_api.rb",
+    "lib/crate_api/base.rb",
+    "lib/crate_api/crate.rb",
+    "lib/crate_api/crateobject.rb",
+    "lib/crate_api/crates.rb",
+    "lib/crate_api/item.rb",
+    "lib/crate_api/items.rb",
+    "test/helper.rb",
+    "test/test_crate_api.rb"
+  ]
+  s.homepage = %q{http://github.com/brianmichel/crate_api}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{Interface with the Crate API}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_crate_api.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<httmultiparty>, [">= 0.3.0"])
+      s.add_runtime_dependency(%q<json>, [">= 1.5.1"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<httmultiparty>, [">= 0.3.0"])
+      s.add_dependency(%q<json>, [">= 1.5.1"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<httmultiparty>, [">= 0.3.0"])
+    s.add_dependency(%q<json>, [">= 1.5.1"])
+  end
+end
+

data/lib/crate_api/base.rb

@@ -0,0 +1,45 @@
+module CrateAPI
+  class NotValidUserError < Exception
+  end
+  
+  class Base
+    include HTTMultiParty
+
+    attr_accessor :auth
+    API_VERSION = 1
+    BASE_URL = "https://api.letscrate.com/#{API_VERSION}"
+    AUTH_URL = "#{BASE_URL}/users/authenticate.json"
+    ITEMS_URL = "#{BASE_URL}/files"
+    CRATES_URL = "#{BASE_URL}/crates"
+    SHORT_URL = "http://lts.cr/%s"
+    def crates(); @crates || CrateAPI::Crates.new(); end
+    def items(); @items || CrateAPI::Items.new(); end
+    
+    def initialize(username, password)
+      raise NotValidUserError unless CrateAPI::Base.authorized?(username, password)
+      @@auth = {:username => username, :password => password}
+    end
+    
+    def self.call(url, verb, params={})
+      params.merge!({:basic_auth => @@auth})
+      resp = nil
+      case verb
+      when :get
+        resp = self.get(url, params)
+      when :post
+        resp = self.post(url, params)
+      end
+      if resp.code == 200
+        return resp.body
+      end
+    end
+    
+    def self.authorized?(user, pass)
+      resp = self.get("#{AUTH_URL}", {:basic_auth => {:username => user, :password => pass}})
+      if resp.code == 401
+        return false
+      end
+      return true
+    end
+  end
+end

data/lib/crate_api/crate.rb

@@ -0,0 +1,34 @@
+module CrateAPI
+  class CrateRenameError < Exception
+  end
+  
+  class CrateDestroyError < Exception
+  end
+  
+  class CrateFileAlreadyExistsError < Exception
+  end
+
+  class Crate < CrateObject
+      attr_reader :files
+      def initialize(hash)
+        super(hash)
+        @files = CrateAPI::Items.from_array(hash["files"])
+      end
+      
+      def destroy
+        response = JSON.parse(CrateAPI::Base.call("#{CrateAPI::Base::CRATES_URL}/#{CrateAPI::Crates::CRATE_ACTIONS[:destroy] % ["#{self.id}"]}", :post))
+        raise CrateDestroyError, response["message"] unless response["status"] != "failure"
+      end
+      
+      def rename(name)
+        response = JSON.parse(CrateAPI::Base.call("#{CrateAPI::Base::CRATES_URL}/#{CrateAPI::Crates::CRATE_ACTIONS[:rename] % ["#{self.id}"]}", :post, {:body => {:name => name}}))
+        raise CrateRenameError, response["message"] unless response["status"] != "failure"
+      end
+      
+      def add_file(path)
+        file = File.new(path)
+        response = CrateAPI::Base.call("#{CrateAPI::Base::ITEMS_URL}/#{CrateAPI::Items::ITEM_ACTIONS[:upload]}", :post, {:body => {:file => file, :crate_id => @id}})
+        raise CrateFileAlreadyExistsError, response["message"] unless response["status"] != "failure"
+      end
+  end
+end

data/lib/crate_api/crateobject.rb

@@ -0,0 +1,15 @@
+module CrateAPI
+  class CrateObject
+    attr_reader :short_code, :name, :id
+
+    def initialize(hash)
+      @short_code = hash["short_code"]
+      @name = hash["name"]
+      @id = hash["id"]
+    end
+
+    def short_url
+      return "#{CrateAPI::Base::SHORT_URL}" % ["#{@short_code}"]
+    end
+  end
+end

data/lib/crate_api/crates.rb

@@ -0,0 +1,37 @@
+module CrateAPI
+  class CrateLimitReachedError < Exception
+  end
+
+  class Crates
+    CRATE_ACTIONS = {
+      :add => "add.json",
+      :list => "list.json",
+      :rename => "rename/%s.json",
+      :destroy => "destroy/%s.json"
+    }
+    
+    def add(name)
+      response = JSON.parse(CrateAPI::Base.call("#{CrateAPI::Base::CRATES_URL}/#{CRATE_ACTIONS[:add]}", :post, {:body => {:name => name}}))
+      raise CrateLimitReachedError, response["message"] unless response["status"] != "failure"
+    end
+
+    def list
+      hash = JSON.parse(CrateAPI::Base.call("#{CrateAPI::Base::CRATES_URL}/#{CRATE_ACTIONS[:list]}", :get))
+      return Crates.from_array(hash["crates"])
+    end
+    
+    def all
+      hash = JSON.parse(CrateAPI::Base.call("#{CrateAPI::Base::ITEMS_URL}/#{CRATE_ACTIONS[:list]}", :get))
+      return Crates.from_array(hash["crates"])
+    end
+    
+    def self.from_array(array)
+      return [] unless array != nil
+      crates = Array.new
+      array.each do |crate|
+        crates.push(Crate.new(crate))
+      end
+      return crates
+    end
+  end
+end

data/lib/crate_api/item.rb

@@ -0,0 +1,16 @@
+module CrateAPI
+  class FileDestroyError < Exception
+  end
+  class Item < CrateObject
+      attr_reader :size
+      def initialize(hash)
+        super(hash)
+        @size = hash["size"]
+      end
+      
+      def destroy
+        response = JSON.parse(CrateAPI::Base.call("#{CrateAPI::Base::ITEMS_URL}/#{CrateAPI::Items::ITEM_ACTIONS[:destroy] % ["#{self.id}"]}", :post))
+        raise FileDestroyError, response["message"] unless response["status"] != "failure"
+      end
+  end
+end

data/lib/crate_api/items.rb

@@ -0,0 +1,19 @@
+module CrateAPI
+  class Items
+    ITEM_ACTIONS = {
+      :upload => "upload.json",
+      :list => "list.json",
+      :show => "show/%s.json",
+      :destroy => "destroy/%s.json"
+    }
+    
+    def self.from_array(array)
+      return [] unless array != nil
+      files = Array.new
+      array.each do |file|
+        files.push(Item.new(file))
+      end
+      return files
+    end
+  end
+end

data/lib/crate_api.rb

@@ -0,0 +1,12 @@
+require "httmultiparty"
+require "JSON"
+
+["base", "crateobject", "crate", "crates", "item", "items"].each do |inc|
+  require File.join(File.dirname(__FILE__), "crate_api", inc)
+end
+
+module CrateAPI
+  def self.new(username, password)
+    CrateAPI::Base.new(username, password)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'crate_api'
+
+class Test::Unit::TestCase
+end

data/test/test_crate_api.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCrateApi < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: crate_api
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brian Michel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: httmultiparty
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: json
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+description: This gem will allow for easy interaction with the Crate API to share your files!
+email: brian.michel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- crate_api.gemspec
+- lib/crate_api.rb
+- lib/crate_api/base.rb
+- lib/crate_api/crate.rb
+- lib/crate_api/crateobject.rb
+- lib/crate_api/crates.rb
+- lib/crate_api/item.rb
+- lib/crate_api/items.rb
+- test/helper.rb
+- test/test_crate_api.rb
+homepage: http://github.com/brianmichel/crate_api
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1029907823158595725
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Interface with the Crate API
+test_files: 
+- test/helper.rb
+- test/test_crate_api.rb