blimp 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blimp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Blake Williams
+
+MIT License
+
+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,55 @@
+# Blimp
+
+Ruby gem that implements [Blimp's](http://www.getblimp.com/) public API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blimp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blimp
+
+
+## Usage
+
+Use the following template for your API credentials. If you don't have them already, you can get them [here](https://app.getblimp.com/user/settings/api/).
+
+```ruby
+Blimp.api_key = "API_KEY"
+Blimp.app_id = "APP_ID"
+Blimp.app_secret = "APP_SECRET"
+Blimp.username = "USERNAME"
+```
+
+This gem implements Company, Project, Goal, Task, Comment, File, and User resources. There are two main methods for finding resources, first there is the `find` method that finds a single instance of a resource by its id. There is also a `find_all` method that returns an array of all of that resource.
+
+
+```ruby
+project = Blimp::Project.find(1)  # Finds a project with an id of 1
+Blimp::Company.find_all # Finds all of the companies you have access to 
+
+project.name = "New Project Name" # Set the name of the project
+project.save # Attempts to save the project's changes
+```
+
+
+## Todo
+
+* Start testing the gem with Minitest
+* Handle required fields when creating new resources
+* Have better error coverage
+
+
+## Contributing
+
+1. Fork it
+3. Commit your changes 
+4. Push to the your fork
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/blimp.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blimp/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "blimp"
+  gem.version       = Blimp::VERSION
+  gem.authors       = ["Blake Williams"]
+  gem.email         = ["blake@blakewilliams.me"]
+  gem.description   = %q{Ruby gem that implements the Blimp Public API http://dev.getblimp.com/}
+  gem.summary       = %q{Ruby bindings to the Blimp API}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency('httparty')
+  gem.add_dependency('active_support')
+end

data/lib/blimp.rb

@@ -0,0 +1,18 @@
+require "blimp/api"
+require "blimp/resource"
+
+require "blimp/company"
+require "blimp/comment"
+require "blimp/file"
+require "blimp/goal"
+require "blimp/task"
+require "blimp/project"
+require "blimp/user"
+
+require "blimp/version"
+
+module Blimp
+  class << self
+    attr_accessor :api_key, :app_secret, :app_id, :username
+  end
+end

data/lib/blimp/api.rb

@@ -0,0 +1,45 @@
+require 'httparty'
+
+module Blimp
+  class API
+    class << self
+      @@base_uri  = "https://app.getblimp.com/api/v2/"
+
+      def headers
+        @headers ||= { 'accept' => 'application/json',
+          'content-type' => 'application/json',
+          'Authorization' => "ApiKey #{Blimp.username}:#{Blimp.api_key}",
+          'X_BLIMP_APPID' => Blimp.app_id,
+          'X_BLIMP_SECRET' => Blimp.app_secret
+        }
+      end
+
+      def method_missing method_name, *args
+        super(method_name, args) unless [:get, :post, :put, :patch, :head, :destroy].include? method_name
+        uri = @@base_uri + args.shift
+
+        body = nil
+        body = args.shift[:body] if args.first.has_key? :body
+
+        query = nil
+        query = args.shift
+
+        HTTParty.send(method_name, uri, headers: headers, query: query, body: body)
+      end
+    end
+
+    class ResponseError < StandardError
+    end
+
+    class NotFound < ResponseError
+    end
+
+    class Forbidden < ResponseError
+    end
+
+    class InternalServerError < ResponseError
+    end
+
+  end
+end
+

data/lib/blimp/comment.rb

@@ -0,0 +1,9 @@
+module Blimp
+  class Comment < Resource
+    ATTRIBUTES = %w[comment object_pk content_type]
+    READ_ONLY = %w[id files date_modified user date_created]
+
+    define_attribute_methods ATTRIBUTES, READ_ONLY
+  end
+end
+

data/lib/blimp/company.rb

@@ -0,0 +1,8 @@
+module Blimp
+  class Company < Resource
+    ATTRIBUTES = %w[name used_projects company_users image_url used_storage]
+    READ_ONLY = %w[id slug date_created date_modified date_due]
+
+    define_attribute_methods ATTRIBUTES, READ_ONLY
+  end
+end

data/lib/blimp/file.rb

@@ -0,0 +1,9 @@
+module Blimp
+  class File < Resource
+    ATTRIBUTES = %w[name versions project source]
+    READ_ONLY = %w[id slug date_created date_modified created_by]
+
+    define_attribute_methods ATTRIBUTES, READ_ONLY
+  end
+end
+

data/lib/blimp/goal.rb

@@ -0,0 +1,10 @@
+module Blimp
+  class Goal < Resource
+    ATTRIBUTES = %w[position date_rejected date_done user_rejected
+                    title project state assigned_to]
+    READ_ONLY = %w[id date_modified created_by date_created]
+
+    define_attribute_methods ATTRIBUTES, READ_ONLY
+  end
+end
+

data/lib/blimp/project.rb

@@ -0,0 +1,8 @@
+module Blimp
+  class Project < Resource
+    ATTRIBUTES = %w[name state team date_due company]
+    READ_ONLY = %w[id slug date_created date_finished date_modified date_due stats]
+
+    define_attribute_methods ATTRIBUTES, READ_ONLY
+  end
+end

data/lib/blimp/resource.rb

@@ -0,0 +1,118 @@
+require 'json'
+
+module Blimp
+  class Resource
+    class << self
+
+      def find(id, options={})
+        uri = member_name
+        uri += "/#{id}" if id
+        parse_response API.get(uri, options)
+      end
+
+      def find_all(options={})
+        uri = member_name
+        parse_response API.get(uri, options), true
+      end
+
+      def parse_response(response, multiple=false)
+        case response.code.to_i
+        when 404
+          raise Blimp::API::NotFound.new(response), "Resource was not found"
+        when 403
+          raise Blimp::API::Forbidden.new(response), "Forbidden"
+        when 500
+          raise Blimp::API::InternalServerError.new(response), "500 Internal Server error. Make sure you're sending a proper request."
+        end
+
+        return build_record(response.parsed_response) unless multiple
+
+        resources = []
+        response.parsed_response['objects'].each do |project|
+          resources.push build_record(project)
+        end
+        return resources
+      end
+
+      def build_record(response)
+        attributes = {}
+        response.each_pair do |key, val|
+          attributes[key] = val if @attributes.include? key
+        end
+        new(attributes)
+      end
+
+      def member_name
+        name.split('::').last.downcase
+      end
+
+
+      def define_attribute_methods(attributes, read_only_attributes)
+        @attributes = attributes | read_only_attributes
+
+        @attributes.each do |name|
+          define_method(name) { self[name] }
+          define_method("#{name}?") {!self[name]}
+          define_method("#{name}=") {|val| self[name] = val} unless read_only_attributes.include?(name)
+        end
+      end
+
+      def define_readonly_attributes(attributes)
+        attributes.each do |name|
+          @attributes.push name
+          define_method(name) { self[name] }
+          define_method("#{name}?") {!self[name]}
+        end
+      end
+
+
+      def create attributes
+        new(attributes)
+        uri = "#{self.member_name}/"
+
+        parse_response Blimp::API.post(uri, body: attributes.to_json)
+      end
+
+    end
+    attr_accessor :attributes
+
+    def initialize attributes = {}
+      raise Error, "#{self.class} is an abstract class and cannot be instantiated" if instance_of? Resource
+
+      @attributes = {}
+      self.attributes = attributes
+    end
+
+    def []=(key,value)
+      @attributes[key] = value
+    end
+
+    def [](key)
+      @attributes[key]
+    end
+
+    def attributes=(attributes = {})
+      attributes.each_pair do |key, val|
+        self[key] = val
+      end
+    end
+
+    def new?
+      self.id?
+    end
+
+    def save
+      uri = "#{self.class.member_name}/"
+      uri += "#{self.id}/" unless self.new?
+
+      attributes = {}
+      @attributes.each_pair do |key,val|
+        next if self.class::READ_ONLY.include? key
+        attributes[key] = val
+      end
+      method = self.new? ? 'post' : 'put'
+      Blimp::API.send method, uri, body: attributes.to_json
+    end
+
+  end
+end

data/lib/blimp/task.rb

@@ -0,0 +1,9 @@
+module Blimp
+  class Task < Resource
+    ATTRIBUTES = %w[position goal user_rejected title project state assigned_to]
+    READ_ONLY = %w[id date_done date_modified created_by date_created
+                   date_set_doing date_checked]
+
+    define_attribute_methods ATTRIBUTES, READ_ONLY
+  end
+end

data/lib/blimp/user.rb

@@ -0,0 +1,8 @@
+module Blimp
+  class User < Resource
+    ATTRIBUTES = %w[profile username first_name last_name email]
+    READ_ONLY = %w[]
+
+    define_attribute_methods ATTRIBUTES, READ_ONLY
+  end
+end

data/lib/blimp/version.rb

@@ -0,0 +1,3 @@
+module Blimp
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: blimp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Blake Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem that implements the Blimp Public API http://dev.getblimp.com/
+email:
+- blake@blakewilliams.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blimp.gemspec
+- lib/blimp.rb
+- lib/blimp/api.rb
+- lib/blimp/comment.rb
+- lib/blimp/company.rb
+- lib/blimp/file.rb
+- lib/blimp/goal.rb
+- lib/blimp/project.rb
+- lib/blimp/resource.rb
+- lib/blimp/task.rb
+- lib/blimp/user.rb
+- lib/blimp/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby bindings to the Blimp API
+test_files: []
+has_rdoc: