copy-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a48afe7aa5c5ea2b0abd8e11f0270c4bd5920388
+  data.tar.gz: 74493f67ce12f9f779c3d81f989688ebabd781dd
+SHA512:
+  metadata.gz: b7a180c4ece7c8b4705a57247e6a6123ae4ae48bb003512f5fd136b9fcb52cb865286bf4f9e7a957d70bc0270a5f45b4e65d953a1ccb428eaad9733428a774ad
+  data.tar.gz: 2a919a45e70748b9d88b351451472ef8a24c9100a06841771eab38bdb74b7fd357c2a519e6392ffe191fa161f01bf235b4a92deba8ece48150c611fa1b2ecf51

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.html
+/.rvmrc
+.project
+.ruby-version
+.ruby-gemset
+/spec/integration/*
+/coverage

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rspec"
+gem "rake"
+gem "webmock"
+gem "pry"
+gem 'multipart-post', '>= 1.1.0'
+gem 'coveralls', require: false

data/LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2012 Andres Bravo
+Copyright (c) 2012 Andres Bravo Internet Service GmbH
+
+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,232 @@
+Copy [![Build Status](https://secure.travis-ci.org/andresbravog/copy-ruby.png)](https://travis-ci.org/andresbravog/copy-ruby) [![Code Climate](https://codeclimate.com/github/andresbravog/copy-ruby.png)](https://codeclimate.com/github/andresbravog/copy-ruby) [![Coverage Status](https://coveralls.io/repos/andresbravog/copy-ruby/badge.png)](https://coveralls.io/r/andresbravog/copy-ruby)
+======
+
+This is a Ruby wrapper for copy's API.
+
+Documentation
+=====
+
+We use RubyDoc for documentation.
+
+Usage
+======
+
+First, you've to install the gem
+
+```Ruby
+  gem install copy
+```
+
+and require it
+
+```Ruby
+  require "copy"
+```
+
+and set up your app credentials
+
+
+```Ruby
+  Copy.config do |configuration|
+    configuration[:consumer_key] = '_your_consumer_key_'
+    configuration[:consumer_secret] = '_your_consumer_secret_'
+  end
+```
+
+in fact this last step is optional (yes! we support multiple applications) but if as most fo the humans you use only one copy app, this is the easyest way to go.
+
+
+Oauth
+=====
+
+*[Copy oauth2 API documentation](https://www.copy.com/developer/documentation#authentication)*
+
+using omniauth? :+1: good choice, just try this gem
+
+  *[plexinc/omniauth-copy](https://github.com/plexinc/omniauth-copy)*
+
+not using omniauth,? no prob oauth implementation comming soon
+
+  ...
+
+
+Client
+======
+
+Everything starts with the client, once you have the user credentials you should create a session and a client to start interaction with the API
+
+```Ruby
+  session = Copy::Session.new(
+    token: '_your_user_token_',
+    secret: '_your_user_secret_'
+  )
+  client = Copy::Client.new(session)
+```
+
+Now you can perform any user api call inside the clien wrapper
+
+```Ruby
+  client.user(:show)
+```
+
+If you have multiple applications or you just want to ve explicit use the application credentials inside the session creation
+
+```Ruby
+  session = Copy::Session.new(
+    token: '_your_user_token_',
+    secret: '_your_user_secret_',
+    consumer_key: '_your_app_key_',
+    consumer_secret: '_your_app_secret'
+  )
+  client = Copy::Client.new(session)
+```
+
+Users
+=====
+
+*[Copy users API documentation](https://www.copy.com/developer/documentation#api-calls/profile)*
+
+Showing user profile:
+
+```Ruby
+  user = client.user(:show)
+```
+
+Updating user (only last_name or first_name)
+
+```Ruby
+  user = client.user(:update, { first_name: 'New name', last_name: 'New last name'})
+```
+
+Files
+=====
+
+*[Copy files API documentation](https://www.copy.com/developer/documentation#api-calls/filesystem)*
+
+Showing root dir:
+
+```Ruby
+ file = client.file(:show)
+```
+
+listing dir children:
+
+files has children if is a dir and is not sutbbed (already being listed form his father)
+
+```Ruby
+  if file.is_dir?
+    file = client.file(:show, id: file.id ) if file.stubbed?
+    file.children
+  end
+```
+
+get file revisions
+
+```Ruby
+  file = client.file(:activity, id: '/copy/readme.txt')
+  revisions = file.revisions
+  file_revision = client.file(:show, id: revisions.first.id )
+```
+
+delete a file
+
+```Ruby
+  client.file(:delete, id: '/test/readme.txt')
+```
+
+create a file. You need to provide a valid copy directory and a file (currently we accept File, Tempfile, String or StringIO objects )
+
+```Ruby
+  file = client.file(:create, path: '/test/readme.txt', file: File.open('path/to/file'))
+```
+
+Links
+=====
+
+*[Copy links API documentation](https://www.copy.com/developer/documentation#api-calls/links)*
+
+List all links created by the user
+
+```Ruby
+  links = client.file(:all)
+```
+
+Show a link
+
+```Ruby
+  link = client.file(:show, id: links.first.id )
+```
+
+List link recipients. Returns a list of users
+
+```Ruby
+  link.recipients if !link.public
+```
+
+Create a new link
+
+```Ruby
+  link = client.link(:create,
+    name: 'My new fancy link',
+    public: true,
+    paths: [
+      '/path/to/the/file_1.txt',
+      '/path/to/the/file_2.txt'
+    ]
+  )
+```
+
+Delete a existing link
+
+```Ruby
+  client.link(:delete, id: link.id )
+```
+
+Get metadata of a link
+
+```Ruby
+  link = client.link(:meta, id: link.id )
+  files = link.children
+```
+
+Get a download link url
+
+```Ruby
+  link = client.link(:show, id: link.id )
+  files = link.download_url
+```
+
+
+Documentation
+=====
+
+*[Copy developers page](https://www.copy.com/developer/signup/)*
+
+*[Copy API documentation](https://www.copy.com/developer/documentation)*
+
+
+Requirements
+=====
+
+This gem requires at least Ruby 1.9 and faces version 1 of Copy's API.
+
+Bugs
+======
+
+Please report bugs at http://github.com/andresbravog/copy-ruby/issues.
+
+Note on Patches/Pull Requests
+======
+
+* Fork the project from http://github.com/andresbravog/copy-ruby.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+======
+
+Copyright (c) 2012-2013 andresbravog Internet Service, Andres Bravo. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/copy.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "copy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "copy-ruby"
+  s.version     = Copy::VERSION
+  s.authors     = ["Andres Bravo"]
+  s.email       = ["hola@andresbravo.com"]
+  s.homepage    = "https://github.com/andresbravog/copy-ruby"
+  s.summary     = %q{API wrapper for Copy.}
+  s.description = %q{API wrapper for Copy.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "json"
+  s.add_dependency 'oauth'
+  s.add_dependency(%q<multipart-post>, [">= 1.1.0"])
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+end

data/lib/copy.rb

@@ -0,0 +1,85 @@
+require "net/http"
+require "net/https"
+require "json"
+require "copy/version"
+
+module Copy
+  DOMAIN_BASE = 'api'
+  API_BASE    = 'copy.com'
+  API_BASE_PATH = 'rest'
+  API_VERSION = '1'
+  ROOT_PATH   = File.dirname(__FILE__)
+
+  @@configuration = {}
+
+  autoload :Base,           "copy/base"
+  autoload :User,           "copy/user"
+  autoload :File,           "copy/file"
+  autoload :Revision,       "copy/revision"
+  autoload :Client,         "copy/client"
+  autoload :Link,           "copy/link"
+  autoload :Session,        "copy/session"
+
+  module Operations
+    autoload :Base,       "copy/operations/base"
+    autoload :All,        "copy/operations/all"
+    autoload :Create,     "copy/operations/create"
+    autoload :Delete,     "copy/operations/delete"
+    autoload :Find,       "copy/operations/find"
+    autoload :Show,       "copy/operations/show"
+    autoload :Update,     "copy/operations/update"
+    autoload :Activity,   "copy/operations/activity"
+    autoload :Meta,       "copy/operations/meta"
+  end
+
+  module Request
+    autoload :Base,       "copy/request/base"
+    autoload :Connection, "copy/request/connection"
+    autoload :Helpers,    "copy/request/helpers"
+    autoload :Info,       "copy/request/info"
+    autoload :Validator,  "copy/request/validator"
+  end
+
+  class CopyError < StandardError; end
+  class AuthenticationError < CopyError; end
+  class NotFound            < CopyError; end
+  class APIError            < CopyError; end
+  class ObjectNotFound      < APIError; end
+  class BadRequest     < APIError; end
+
+
+  # Gives configuration abilities
+  # to setup api_key and api_secret
+  #
+  # @example
+  #   Copy.config do |configuration|
+  #     configuration[:api_key] = '_your_api_key'
+  #     configuration[:api_secret] = '_your_api_secret'
+  #   end
+  #
+  # @return [String] The api key
+  def self.config(&block)
+    yield(@@configuration)
+    @@configuration
+  end
+
+  def self.configuration
+    @@configuration
+  end
+
+  def self.configuration=(value)
+    @@configuration = value
+  end
+
+  # Makes a request against the Copy API
+  #
+  # @param [Symbol] http_method The http method to use, must be one of :get, :post, :put and :delete
+  # @param [String] domain The API domain to use
+  # @param [String] api_url The API url to use
+  # @param [Hash] data The data to send, e.g. used when creating new objects.
+  # @return [Array] The parsed JSON response.
+  def self.request(http_method, domain, api_url, data, options={})
+    info = Request::Info.new(http_method, domain, api_url, data, options)
+    Request::Base.new(info).perform
+  end
+end

data/lib/copy/base.rb

@@ -0,0 +1,43 @@
+module Copy
+  class Base
+    include Copy::Operations::Base
+
+    attr_accessor :created_time
+
+    # Initializes the object using the given attributes
+    #
+    # @param [Hash] attributes The attributes to use for initialization
+    def initialize(attributes = {})
+      set_attributes(attributes)
+      parse_timestamps
+    end
+
+    # Model validations
+    #
+    # @return [Boolean]
+    def valid?
+      self.errors.empty?
+    end
+
+    # Accesor for the errors
+    #
+    def errors
+      @errors || []
+    end
+
+    # Sets the attributes
+    #
+    # @param [Hash] attributes The attributes to initialize
+    def set_attributes(attributes)
+      attributes.each_pair do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    # Parses UNIX timestamps and creates Time objects.
+    def parse_timestamps
+      @created_time = created_time.to_i if created_time.is_a? String
+      @created_time = Time.at(created_time) if created_time
+    end
+  end
+end