colourlovers 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 colourlovers.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Masters
+
+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,111 @@
+# Colourlovers
+
+A simple gem to use to make it easy to use the COLOURlovers API.
+
+http://www.colourlovers.com/api
+
+This is my first gem and there are currently no tests, bt I am working on it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'colourlovers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install colourlovers
+
+## Usage
+
+
+```ruby
+
+cl = Colourlovers::Client.new
+
+# for colors (parameters supported)
+colors = cl.colors({:numResults => 3, :lover => 'COLOURlover'})
+top_colors = cl.top_colors({:numResults => 3})
+new_colors = cl.new_colors({:numResults => 3})
+random_color = cl.random_color
+color = cl.color('FFFFFF')
+
+p "colors"
+p colors
+p "top_colors"
+p top_colors
+p "new_colors"
+p new_colors
+p "random_color"
+p random_color
+p "color"
+p color
+
+# for palettes (parameters supported)
+palettes = cl.palettes({:numResults => 5})
+top_palettes = cl.top_palettes({:numResults => 3})
+new_palettes = cl.new_palettes({:numResults => 3})
+random_palette = cl.random_palette
+palette = cl.palette('113451')
+
+p "palettes"
+p palettes
+p "top_palettes"
+p top_palettes
+p "new_palettes"
+p new_palettes
+p "random_palette"
+p random_palette
+p "palette"
+p palette
+
+# for patterns (parameters supported)
+patterns = cl.patterns({:numResults => 5})
+top_patterns = cl.top_patterns({:numResults => 3})
+new_patterns = cl.new_patterns({:numResults => 3})
+random_pattern = cl.random_pattern
+pattern = cl.pattern('1451')
+
+p "patterns"
+p patterns
+p "top_patterns"
+p top_patterns
+p "new_patterns"
+p new_patterns
+p "random_pattern"
+p random_pattern
+p "pattern"
+p pattern
+
+# for lovers (parameters supported)
+lovers = cl.lovers({:numResults => 5})
+top_lovers = cl.top_lovers({:numResults => 3})
+new_lovers = cl.new_lovers({:numResults => 3})
+lover = cl.lover('COLOURlover')
+
+p "lovers"
+p lovers
+p "top_lovers"
+p top_lovers
+p "new_lovers"
+p new_lovers
+p "lover"
+p lover
+
+
+
+```
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/colourlovers.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/colourlovers/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Chris Masters"]
+  gem.email         = ["chrismasters@gmail.com"]
+  gem.description   = %q{A simple gem to use to make it easy to use the COLOURlovers API http://www.colourlovers.com/api. This is my first gem and there are currently no tests, bt I am working on it.}
+  gem.summary       = %q{A ruby wrapper for the COLOURlovers API}
+  gem.homepage      = "https://github.com/chrism/COLOURlovers"
+
+  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.name          = "colourlovers"
+  gem.require_paths = ["lib"]
+  gem.version       = Colourlovers::VERSION
+  
+  gem.add_dependency "httparty"
+  gem.add_development_dependency "rake"
+end

data/lib/colourlovers.rb

@@ -0,0 +1,8 @@
+require 'httparty'
+
+require "colourlovers/version"
+require 'colourlovers/client'
+require 'colourlovers/color'
+require 'colourlovers/palette'
+require 'colourlovers/pattern'
+require 'colourlovers/lover'

data/lib/colourlovers/client.rb

@@ -0,0 +1,186 @@
+module Colourlovers
+   
+  class Client
+  
+    include HTTParty
+    default_params :format => 'json'
+    base_uri 'http://www.colourlovers.com/api'
+    
+    # Rather than making laborious calls to `Colourlovers::Client.colors` you can create an instance
+    # of the {Colourlovers::Client} and call methods on it. Instance methods will be defined for 
+    # class methods on their first utilization.
+    # @example
+    #   cl = Colourlovers::Client.new
+    #   cl.colors    #=> [...]
+    def method_missing(method, *args, &block)
+      super unless self.class.respond_to? method
+      self.class.class_eval do
+        define_method method do |*args, &block|
+          self.class.send(method, *args, &block)
+        end
+      end
+      self.class.send(method, *args, &block)
+    end
+    
+    class << self
+      
+      
+      # Handle responses from HTTParty calls to the COLOURlovers API with
+      # some generic response interpretation and manipulation. 
+      # @todo Add individual errors for various HTTP Status codes
+      def handle_response(response)
+        status = response.code
+        
+        case status
+          when 404 then STDERR.puts "404 - maybe COLOURlovers down? #{$!}"
+          when 400..499 then STDERR.puts "400-499 - maybe COLOURlovers down? #{$!}"
+          when 500..599 then STDERR.puts "500-599 - maybe COLOURlovers down? #{$!}"
+          else response.first
+        end
+
+      end
+      private :handle_response
+      
+      # Handle all HTTParty responses with some error handling so that our
+      # individual methods don't have to worry about it at all (although they)
+      # can (and should where relevant) rescue from errors when they are able to.
+      [:get, :head, :post, :put, :delete].each do |http_verb|
+        define_method http_verb do |*args|
+          begin
+            handle_response super(*args)
+          rescue Exception
+            STDERR.puts "socketerror - maybe no connection? #{$!}"
+            exit
+          end
+        end
+      end
+      
+       
+      
+      ## COLORS ##
+         
+      # List colors
+      # @see Colourlovers::Color.all
+      def colors(options={})
+        Color.all(options)
+      end
+      
+      # List top colors
+      # @see Colourlovers::Color.top
+      def top_colors(options={})
+        Color.top(options)
+      end
+  
+      # List new colors
+      # @see Colourlovers::Color.new
+      def new_colors(options={})
+       Color.new(options)
+      end
+    
+      # Retrieve random color
+      # @see Colourlovers::Color.random
+      def random_color
+        Color.random
+      end
+      
+      # Retrieve color from hex value
+      # @see Colourlovers::Color.find
+      def color(hex)
+        Color.find(hex)
+      end
+      
+      ## PALETTES ##
+      
+      # List palettes
+      # @see Colourlovers::Palette.all
+      def palettes(options={})
+        Palette.all(options)
+      end
+      
+      # List top palettes
+      # @see Colourlovers::Palette.top
+      def top_palettes(options={})
+        Palette.top(options)
+      end
+  
+      # List new palettes
+      # @see Colourlovers::Palette.new
+      def new_palettes(options={})
+       Palette.new(options)
+      end
+    
+      # Retrieve random palette
+      # @see Colourlovers::Palette.random
+      def random_palette
+        Palette.random
+      end
+      
+      # Retrieve palette from paletteID
+      # @see Colourlovers::Palette.find
+      def palette(paletteID)
+        Palette.find(paletteID)
+      end 
+      
+      ## PATTERNS ##
+      
+      # List patterns
+      # @see Colourlovers::Pattern.all
+      def patterns(options={})
+        Pattern.all(options)
+      end
+      
+      # List top patterns
+      # @see Colourlovers::Pattern.top
+      def top_patterns(options={})
+        Pattern.top(options)
+      end
+  
+      # List new patterns
+      # @see Colourlovers::Pattern.new
+      def new_patterns(options={})
+       Pattern.new(options)
+      end
+    
+      # Retrieve random pattern
+      # @see Colourlovers::Pattern.random
+      def random_pattern
+        Pattern.random
+      end
+      
+      # Retrieve pattern from patternID
+      # @see Colourlovers::Pattern.find
+      def pattern(patternID)
+        Pattern.find(patternID)
+      end 
+      
+      ## LOVERS ##
+      
+      # List lovers
+      # @see Colourlovers::Lover.all
+      def lovers(options={})
+        Lover.all(options)
+      end
+      
+      # List top lovers
+      # @see Colourlovers::Lover.top
+      def top_lovers(options={})
+        Lover.top(options)
+      end
+  
+      # List new lovers
+      # @see Colourlovers::Lover.new
+      def new_lovers(options={})
+       Lover.new(options)
+      end
+      
+      # Retrieve lover from username
+      # @see Colourlovers::Lover.find
+      def lover(username)
+        Lover.find(username)
+      end 
+           
+    end
+    
+  end
+  
+end

data/lib/colourlovers/color.rb

@@ -0,0 +1,46 @@
+module Colourlovers
+  
+  class Color
+         
+    class << self
+      
+      # Retrieve colors as an array of hashes with options available from Colourlovers API
+      # see documentation here: http://www.colourlovers.com/api#colors
+      # lover	=	COLOURlover
+      # hueRange	=	12,68   [values must be 0>value<359, and the left value must be less than the right value]
+      # briRange	=	2,88   [values must be 0>value<99, and the left value must be less than the right value]
+      # keywords	=	search+term
+      # keywordExact	=	0 or 1   [Perform an exact search for the keywords passed. Default 0]
+      # orderCol	=	X   [Where X can be: dateCreated, score, name, numVotes, or numViews]
+      # sortBy	=	X   [Where X can be: ASC or DESC. Default ASC]
+      # numResults	=	20   [Number of results to return, maximum of 100. Default 20]
+      # resultOffset	=	5   [Result offset, for paging. Default 0]        
+      def all(options)  
+        Client.get("/colors", :query => options)
+      end
+      
+      # Retrives colors as an array of hashes, same options as all but ordered by popularity
+      def top(options)  
+        Client.get("/colors/top", :query => options)
+      end
+
+      # Retrives colors as an array of hashes, same options as all but ordered by dateCreated
+      def new(options)  
+        Client.get("/colors/new", :query => options)
+      end     
+      
+      # Retrieve random color as an array with one hash, no parameters allowed
+      def random
+        Client.get("/colors/random")
+      end
+      
+      # Retrieve color details from hex value as an array with one hash
+      def find(hex)
+        Client.get("/color/#{hex}")
+      end
+           
+    end
+    
+  end
+   
+end

data/lib/colourlovers/lover.rb

@@ -0,0 +1,36 @@
+module Colourlovers
+  
+  class Lover
+         
+    class << self
+      
+      # Retrieve lovers as an array of hashes with options available from Colourlovers API
+      # see documentation here: http://www.colourlovers.com/api#lovers
+      # orderCol  =  X   [Where X can be: dateCreated, score, name, numVotes, or numViews]
+      # sortBy  =  X   [Where X can be: ASC or DESC. Default ASC]
+      # numResults  =  20   [Number of results to return, maximum of 100. Default 20]
+      # resultOffset  =  5   [Result offset, for paging. Default 0]     
+      def all(options)  
+        Client.get("/lovers", :query => options)
+      end
+      
+      # Retrives lovers as an array of hashes, same options as all but ordered by popularity
+      def top(options)  
+        Client.get("/lovers/top", :query => options)
+      end
+
+      # Retrives lovers as an array of hashes, same options as all but ordered by dateCreated
+      def new(options)  
+        Client.get("/lovers/new", :query => options)
+      end     
+      
+      # Retrieve lover details from username as an array with one hash
+      def find(username)
+        Client.get("/lover/#{username}")
+      end
+           
+    end
+    
+  end
+   
+end

data/lib/colourlovers/palette.rb

@@ -0,0 +1,50 @@
+module Colourlovers
+  
+  class Palette
+         
+    class << self
+      
+      # Retrieve palettes as an array of hashes with options available from Colourlovers API
+      # see documentation here: http://www.colourlovers.com/api#palettes
+      # lover  =  COLOURlover
+      # hueOption  =  yellow,orange,red  or  green,violet  or  blue
+      # [Possible Values can be a combination of: red, orange, yellow, green, aqua, blue, violet, and / or fuchsia]
+      # hex  =  00FF33   [Possible Values: any valid 6-char hex value]
+      # keywords  =  search+term
+      # keywordExact  =  0 or 1   [Perform an exact search for the keywords passed. Default 0]
+      # orderCol  =  X   [Where X can be: dateCreated, score, name, numVotes, or numViews]
+      # sortBy  =  X   [Where X can be: ASC or DESC. Default ASC]
+      # numResults  =  20   [Number of results to return, maximum of 100. Default 20]
+      # resultOffset  =  5   [Result offset, for paging. Default 0]
+      # format  =  json or xml   [Result format. Default is xml]
+      # jsonCallback  =  yourCallbackFunction   [Adds a callback to JSON format. Assumes format=json]
+      # showPaletteWidths  =  0 or 1   [Shows palette's color's widths. Default 0]   
+      def all(options)  
+        Client.get("/palettes", :query => options)
+      end
+      
+      # Retrives palettes as an array of hashes, same options as all but ordered by popularity
+      def top(options)  
+        Client.get("/palettes/top", :query => options)
+      end
+
+      # Retrives palettes as an array of hashes, same options as all but ordered by dateCreated
+      def new(options)  
+        Client.get("/palettes/new", :query => options)
+      end     
+      
+      # Retrieve random palette as an array with one hash, no parameters allowed
+      def random
+        Client.get("/palettes/random")
+      end
+      
+      # Retrieve palette details from paletteID as an array with one hash
+      def find(paletteID)
+        Client.get("/palette/#{paletteID}")
+      end
+           
+    end
+    
+  end
+   
+end

data/lib/colourlovers/pattern.rb

@@ -0,0 +1,47 @@
+module Colourlovers
+  
+  class Pattern
+         
+    class << self
+      
+      # Retrieve patterns as an array of hashes with options available from Colourlovers API
+      # see documentation here: http://www.colourlovers.com/api#patterns
+      # lover  =  COLOURlover
+      # hueOption  =  yellow,orange,red  or  green,violet  or  blue
+      # [Possible Values can be a combination of: red, orange, yellow, green, aqua, blue, violet, and / or fuchsia]
+      # hex  =  00FF33 [Possible Values: any valid 6-char hex value]
+      # keywords  =  search+term
+      # keywordExact  =  0 or 1 [Perform an exact search for the keywords passed. Default 0]
+      # orderCol  =  X [Where X can be: dateCreated, score, name, numVotes, or numViews]
+      # sortBy  =  X [Where X can be: ASC or DESC. Default ASC]
+      # numResults  =  20 [Number of results to return, maximum of 100. Default 20]
+      # resultOffset  =  5 [Result offset, for paging. Default 0]      
+      def all(options)  
+        Client.get("/patterns", :query => options)
+      end
+      
+      # Retrives patterns as an array of hashes, same options as all but ordered by popularity
+      def top(options)  
+        Client.get("/patterns/top", :query => options)
+      end
+
+      # Retrives patterns as an array of hashes, same options as all but ordered by dateCreated
+      def new(options)  
+        Client.get("/patterns/new", :query => options)
+      end     
+      
+      # Retrieve random pattern as an array with one hash, no parameters allowed
+      def random
+        Client.get("/patterns/random")
+      end
+      
+      # Retrieve pattern details from patternID
+      def find(patternID)
+        Client.get("/pattern/#{patternID}")
+      end
+           
+    end
+    
+  end
+   
+end

data/lib/colourlovers/version.rb

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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: colourlovers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Masters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70281982366840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70281982366840
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70281982366420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70281982366420
+description: A simple gem to use to make it easy to use the COLOURlovers API http://www.colourlovers.com/api.
+  This is my first gem and there are currently no tests, bt I am working on it.
+email:
+- chrismasters@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- colourlovers.gemspec
+- lib/colourlovers.rb
+- lib/colourlovers/client.rb
+- lib/colourlovers/color.rb
+- lib/colourlovers/lover.rb
+- lib/colourlovers/palette.rb
+- lib/colourlovers/pattern.rb
+- lib/colourlovers/version.rb
+homepage: https://github.com/chrism/COLOURlovers
+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'
+      segments:
+      - 0
+      hash: 4566665335935066597
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4566665335935066597
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the COLOURlovers API
+test_files: []