ravelry 0.0.1

data/lib/ravelry/photo.rb

@@ -0,0 +1,69 @@
+module Ravelry
+
+  # The information used to create `Ravelry::Photo` currently comes from {Ravelry::Pattern} objects.
+  #
+  # See {Ravelry::Pattern} for more information about `Pattern` objects.
+  #
+  # To utilize the `get`, `post`, `delete`, `get_sizes` methods, you have to be authenticated.
+  #
+  class Photo < Data
+    
+    def build; end
+
+    def get
+      # TODO - requires authentication
+    end
+
+    def post
+      # TODO - requires authentication
+    end
+
+    def delete
+      # TODO - requires authentication
+    end
+
+    def get_sizes
+      # TODO - requires authentication
+    end
+
+    def flickr_url
+      data[:flickr_url]
+    end
+
+    def small_url
+      data[:small_url]
+    end
+
+    def medium_url
+      data[:medium_url]
+    end
+
+    def square_url
+      data[:square_url]
+    end
+
+    def thumbnail_url
+      data[:thumbnail_url]
+    end
+
+    def shelved_url
+      data[:shelved_url]
+    end
+
+    def sort_order
+      data[:sort_order]
+    end
+
+    # Offsets are used to place a small image in a 170x170 pixel square frame.
+    #
+    def x_offset
+      data[:x_offset]
+    end
+
+    # Offsets are used to place a small image in a 170x170 pixel square frame.
+    #
+    def y_offset
+      data[:y_offset]
+    end
+  end
+end

data/lib/ravelry/printing.rb

@@ -0,0 +1,70 @@
+module Ravelry
+
+  # The information used to create `Ravelry::Printing` objects comes from {Ravelry::Pattern} objects.
+  #
+  # You should not create `Printing` objects manually; they are all created–and owned–by a {Ravelry::Pattern}.
+  #
+  # See {Ravelry::Pattern} for more information about `Pattern` objects.
+  #
+  class Printing
+
+    attr_reader :price, :permalink, :name, :author, :url, :amazon_rating, :pattern_count, :amazon_url, :shelf_image_path, :list_price
+
+    def initialize(printing)
+      @printing = printing
+      @pattern_source = printing[:pattern_source]
+
+      # Price of the printing source.
+      #
+      @price = @pattern_source[:price]
+
+      # Permalink for printing.
+      #
+      @permalink = @pattern_source[:permalink]
+
+      # Name of the printing.
+      #
+      @name = @pattern_source[:name]
+
+      # Author of the printed source (if any).
+      #
+      @author = @pattern_source[:author]
+
+      # URL of the printing.
+      #
+      @url = @pattern_source[:url]
+
+      # Printing's rating on Amazon.
+      #
+      @amazon_rating = @pattern_source[:amazon_rating]
+
+      # Number of patterns available in this printing.
+      #
+      @pattern_count = @pattern_source[:pattern_count]
+
+      # Printing's Amazon URL.
+      #
+      @amazon_url = @pattern_source[:amazon_url]
+
+      # Path to image, if any.
+      #
+      @shelf_image_path = @pattern_source[:shelf_image_path]
+
+      # List price of the printing.
+      #
+      @list_price = @pattern_source[:list_price]
+    end
+
+    # Boolean value. Is this resource out of print?
+    #
+    def out_of_print?
+      @pattern_source[:out_of_print]
+    end
+
+    # Boolean value. Is this the primary source of the pattern?
+    #
+    def primary_source?
+      @printing[:primary_source]
+    end
+  end
+end

data/lib/ravelry/utils/build.rb

@@ -0,0 +1,128 @@
+module Ravelry
+
+  # Utility module that takes the JSON response from the API call and creates the appropriate objects.
+  #
+  module Build
+
+    # Creates and returns a {Ravelry::Author} object.
+    #
+    # See {Ravelry::Author} for more information.
+    #
+    def self.author(data)
+      @author = Author.new(data[:pattern_author])
+    end
+
+    # Creates and returns an array of {Ravelry::Category} objects.
+    #
+    # See {Ravelry::Category} for more information.
+    #
+    def self.categories(data)
+      @categories = []
+      data[:pattern_categories].each do |cat|
+        @categories << Category.new(cat)
+      end
+      @categories
+    end
+
+    # Creates and returns a {Ravelry::Craft} object.
+    #
+    # See {Ravelry::Craft} for more information.
+    #
+    def self.craft(data)
+      @craft = Craft.new(data[:craft])
+    end
+
+    # Creates and returns an array of {Ravelry::PatternNeedle} objects.
+    #
+    # There is more than one API endpoint for Needles. This may not be the one you are looking for.
+    #
+    # See {Ravelry::PatternNeedle} for more information.
+    #
+    def self.needles(data)
+      @needles = []
+      data[:pattern_needle_sizes].each do |ndl|
+        @needles << PatternNeedle.new(ndl)
+      end
+      @needles
+    end
+
+    # Creates and returns an array of {Ravelry::Pack} objects.
+    #
+    # See {Ravelry::Pack} for more information.
+    #
+    def self.packs(data)
+      @packs = []
+      data[:packs].each do |pack_data|
+        pack = Pack.new
+        pack.data = pack_data
+        @packs << pack
+      end
+      @packs
+    end
+
+    # Creates and returns a of {Ravelry::PatternType} object.
+    #
+    # This is not the same as a PatternCategory object.
+    #
+    # See {Ravelry::PatternType} for more information.
+    #
+    def self.pattern_type(data)
+      @pattern_type = PatternType.new(data[:pattern_type])
+    end
+
+    # Creates and returns an array of {Ravelry::Photo} objects.
+    #
+    # See {Ravelry::Photo} for more information.
+    #
+    def self.photos(data)
+      @photos = []
+      data[:photos].each do |photo_data|
+        photo = Photo.new(photo_data[:id])
+        photo.data = photo_data
+        @photos << photo
+      end
+      @photos
+    end
+
+    # Creates and returns an array of {Ravelry::Printing} objects.
+    #
+    # See {Ravelry::Printing} for more information.
+    #
+    def self.printings(data)
+      @printings = []
+      data[:printings].each do |printing_data|
+        @printings << Printing.new(printing_data)
+      end
+      @printings
+    end
+
+    # Creates and returns an array of {Ravelry::Yarn} objects.
+    #
+    # See {Ravelry::Yarn} for more information.
+    #
+    def self.yarns(data)
+      @yarns = []
+      data[:packs].each do |pack_data|
+        yarn = Yarn.new
+        yarn.data = pack_data[:yarn]
+        @yarns << yarn
+      end
+      @yarns
+    end
+
+    # Creates and returns an array of {Ravelry::YarnWeight} objects.
+    #
+    # See {Ravelry::YarnWeight} for more information.
+    #
+    def self.yarn_weights(data)
+      @yarn_weights = []
+      data[:packs].each do |pack|
+        yarn_weight = YarnWeight.new
+        yarn_weight.data = pack[:yarn_weight]
+        @yarn_weights << yarn_weight
+      end
+      @yarn_weights
+    end
+
+  end
+end

data/lib/ravelry/utils/utilities.rb

@@ -0,0 +1,14 @@
+module Ravelry
+
+  # Utility module that handles date, string, and number parsing.
+  #
+  module Utilities
+
+    # Expects a format readable by Ruby's Date library.
+    #
+    def self.pretty_full_date(string)
+      parsed = Date.parse(string)
+      parsed.strftime("%B %e, %Y")
+    end
+  end
+end

data/lib/ravelry/version.rb

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

data/lib/ravelry/yarn.rb

@@ -0,0 +1,39 @@
+module Ravelry
+
+  #  The information used to create `Ravelry::Yarn` currently comes from {Ravelry::Pattern} objects.
+  # 
+  # See {Ravelry::Pattern} for more information about `Pattern` objects.
+  # 
+  # This class will be updated in future to perform GET, POST, PUT, and DESTROY requests.
+  # 
+  class Yarn < Data
+
+    def build; end
+
+    # Gets yarn permalink from existing `data`.
+    def permalink
+      data[:permalink]
+    end
+
+    # Gets yarn company from existing `data`.
+    def company
+      data[:yarn_company_name]
+    end
+
+    # Gets yarn name from existing `data`.
+    def name
+      data[:name]
+    end
+
+    # Gets yarn company_id from existing `data`.
+    def company_id
+      data[:yarn_company_id]
+    end
+
+    # Handles API call and parses JSON response. 
+    def fetch_and_parse
+      # TODO
+    end
+  end
+
+end

data/lib/ravelry/yarn_weight.rb

@@ -0,0 +1,48 @@
+module Ravelry
+
+  #  The information used to create `Ravelry::YarnWeight` currently comes from {Ravelry::Pattern} objects.
+  #
+  # See {Ravelry::Pattern} for more information about `Pattern` objects.
+  #
+  # This class will be updated in future to perform GET, POST, PUT, and DESTROY requests.
+  #
+  class YarnWeight < Data
+
+    def build; end
+
+    # Gets yarn weight's name from existing `data`.
+    def name
+      data[:name]
+    end
+
+    # Gets yarn weight's min_gauge from existing `data`.
+    def min_gauge
+      data[:min_gauge]
+    end
+
+    # Gets yarn weight's wpi from existing `data`.
+    def wpi
+      data[:wpi]
+    end
+
+    # Gets yarn weight's crochet_gauge from existing `data`.
+    def crochet_gauge
+      data[:crochet_gauge]
+    end
+
+    # Gets yarn weight's ply from existing `data`.
+    def ply
+      data[:ply]
+    end
+
+    # Gets yarn weight's knit_gauge from existing `data`.
+    def knit_gauge
+      data[:knit_gauge]
+    end
+
+    # Gets yarn weight's max_gauge from existing `data`.
+    def max_gauge
+      data[:max_gauge]
+    end
+  end
+end

data/ravelry.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ravelry/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "ravelry"
+  spec.version = Ravelry::VERSION
+  spec.authors = ["Liz Abinante"]
+  spec.date = "2013-12-22"
+  spec.summary = "Ruby gem for accessing the Ravelry API."
+  spec.description = "Ruby gem for accessing the Ravelry API painlessly, easily, and awesomely."
+  spec.email = "me@liz.codes"
+  spec.homepage = "http://github.com/ArtCraftCode/ravelry"
+  spec.licenses = ["MIT"]
+  spec.require_paths = ["lib"]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "typhoeus", "~> 0.6"
+end
+

data/spec/helpers/helpers.rb

@@ -0,0 +1,106 @@
+module Helpers
+  # Generic test helpers
+
+  def pattern_author
+    {
+      :permalink=>"liz-abinante", :name=>"Liz Abinante", :id=>19297,
+      :favorites_count=>1314, :patterns_count=>48
+    }
+  end
+
+  def yarn_hash
+    {
+      :permalink=>"miss-babs-yummy-superwash-sport---3-ply",
+      :yarn_company_name=>"Miss Babs",
+      :yarn_company_id=>1119,
+      :name=>"Yummy Superwash Sport - 3 Ply",
+      :id=>18714
+    }
+  end
+
+  def yarn_weight_hash
+    {
+      :name=>"Sport",
+      :min_gauge=>nil,
+      :wpi=>"12",
+      :id=>10,
+      :crochet_gauge=>nil,
+      :ply=>"5",
+      :knit_gauge=>"24-26",
+      :max_gauge=>nil
+    }
+  end
+
+  def categories
+    {
+      :permalink=>"shawl-wrap", :name=>"Shawl / Wrap", :id=>350,
+      :parent=>
+        {
+          :permalink=>"neck-torso", :name=>"Neck / Torso", :id=>338,
+          :parent=>
+            {
+              :permalink=>"accessories", :name=>"Accessories", :id=>337,
+              :parent=>
+                {
+                  :permalink=>"categories", :name=>"Categories", :id=>301
+                }
+            }
+        }
+    }
+  end
+
+  def craft
+    { :permalink=>"knitting", :name=>"Knitting", :id=>2 }
+  end
+
+  def needle
+    { :hook=>"E", :us_steel=>"00", :name=>"US 4  - 3.5 mm",
+      :crochet=>false, :metric=>3.5, :knitting=>true, :us=>"4 ",
+      :id=>4 }
+  end
+
+  def pattern_type
+    {
+      :permalink=>"shawl", :name=>"Shawl/Wrap", :clothing=>true,
+      :id=>10
+    }
+  end
+
+  def photo
+    { :flickr_url=>nil,
+      :small_url=>"http://images4.ravelrycache.com/uploads/feministy/197032385/_D7C0070-Edit-Edit_small_best_fit.JPG",
+      :x_offset=>-82,
+      :shelved_url=>"http://images4.ravelrycache.com/uploads/feministy/197032385/_D7C0070-Edit-Edit_shelved.JPG",
+      :y_offset=>0,
+      :sort_order=>1,
+      :id=>35912328,
+      :square_url=>"http://images4-b.ravelrycache.com/uploads/feministy/197032385/_D7C0070-Edit-Edit_square.JPG",
+      :medium_url=>"http://images4.ravelrycache.com/uploads/feministy/197032385/_D7C0070-Edit-Edit_medium.JPG",
+      :thumbnail_url=>"h"
+    }
+  end
+
+  def printing
+    [
+      {:pattern_source=>
+        {
+          :price=>nil, :permalink=>"liz-abinantes-ravelry-store",
+          :out_of_print=>false, :name=>"Liz Abinante's Ravelry Store",
+          :author=>nil, :url=>"http://www.ravelry.com/stores/feministy",
+          :amazon_rating=>nil, :pattern_count=>3, :amazon_url=>nil,
+          :shelf_image_path=>nil, :list_price=>nil
+        },
+      :primary_source=>true
+      },
+      {:pattern_source=>
+        {
+          :price=>nil, :permalink=>"feministy", :out_of_print=>false,
+          :name=>"Feministy.com", :author=>"", :url=>"http://feministy.com/",
+          :amazon_rating=>nil, :pattern_count=>47, :amazon_url=>nil,
+          :shelf_image_path=>nil, :list_price=>nil
+        },
+      :primary_source=>false
+      }
+    ]
+  end
+end