ravelry 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9109931a9b33ea14a93c82f5fd81d4ad1f2d47ea
-  data.tar.gz: 1a5fd7b46c9049d75f5255772f27d667e39ffe53
+  metadata.gz: 069008bb3012510d0c56139996efd09180c18c35
+  data.tar.gz: da328e573a10420115bb936ca902b68c54ddcc60
 SHA512:
-  metadata.gz: bac3a69cd317f41303aeb7a8accd7b85c1b64d1f549033906aadcd3100ef8259b2cf0d3403b7fa8ecc6d71d40eb1d47ec054ed096a131b26ea950c8783d5996d
-  data.tar.gz: 7a45bd027bf36ed7a8ff3f078132ef1e39148b8de8ecad9a5367dec2fd1f4a5ac9581ac1b92ece8080607a0f5c770c0ec206dfa3c02652cb1108320ead0a04e8
+  metadata.gz: 0b0ef35f8f4eeebcf3994cab99ee7a56acc01053a84b16707ffe3aec8ab398b19782f1a6c6182b4f77c010307a5126acc98e20f471afb90a7f918934be01279d
+  data.tar.gz: 2aa97bb1a10842a9aec7d41bd5c500a0379c5ed81a1bfac16fd907b69891151a75e00d7411ffac21ffe1f6cf5069f98fc9a92f3923d1d4e33b6c18dbb8b9a62f

data/README.md

@@ -1,8 +1,8 @@
 # Ravelry
 
-_You are reading documentation for version: 0.0.5_
+_You are reading documentation for version: 0.0.6_
 
-[ ![Codeship Status for ArtCraftCode/ravelry](https://codeship.com/projects/fc6710e0-5719-0133-36cc-5ebc52a48109/status?branch=0.0.5)](https://codeship.com/projects/109462)
+[ ![Codeship Status for ArtCraftCode/ravelry](https://codeship.com/projects/fc6710e0-5719-0133-36cc-5ebc52a48109/status?branch=0.0.6)](https://codeship.com/projects/109462)
 
 This gem is actively being developed. Be sure to check the branch for the version you're using as breaking changes can (and will!) be introduced.
 
@@ -14,10 +14,17 @@ Ravelry API documentation is currently available [here](http://www.ravelry.com/a
 
 ## API coverage
 
-* [`Patterns#show`](http://www.ravelry.com/api#patterns_show) maps to `Ravelry::Pattern`
-* [`People#show`](http://www.ravelry.com/api#people_show) maps to `Ravelry::User`
-* [`Misc#color_families`](http://www.ravelry.com/api#/_color_families) maps to `Ravelry::Misc.color_families`
-* [`Misc#yarn_weights`](http://www.ravelry.com/api#/_yarn_weights) maps to `Ravelry::Misc.yarn_weights`
+See documentation for each class (or module) to see how to initialize the objects.
+
+API | Endpoint | Ravelry gem class / module
+----|----------|------------------
+**Misc** | [color_families](http://www.ravelry.com/api#/_color_families) | `Ravelry::Misc.color_families`
+**Misc** | [yarn_weights](http://www.ravelry.com/api#/_yarn_weights) | `Ravelry::Misc.yarn_weights`
+**Needles** | [list](http://www.ravelry.com/api#needles_list) | `Ravelry::Needles.list`
+**Needles** | [sizes](http://www.ravelry.com/api#needles_sizes) | `Ravelry::Needles.sizes`
+**Needles** | [types](http://www.ravelry.com/api#needles_types) | `Ravelry::Needles.types`
+**Patterns** | [show](http://www.ravelry.com/api#patterns_show) | `Ravelry::Pattern.get`
+**People** | [show](http://www.ravelry.com/api#people_show) | `Ravelry::User.get`
 
 # Installation
 
@@ -32,7 +39,7 @@ Hooray! You now have a gem.
 Add to your `Gemfile`:
 
 ```ruby
-gem "ravelry", "~> 0.0.5"
+gem "ravelry", "~> 0.0.6"
 ```
 
 **I highly recommend pinning your version** because the gem is in active development and I _promise_ I will break shit.
@@ -67,7 +74,7 @@ Ravelry.configuration.personal_key
 
 # Usage
 
-Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.0.5).
+Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.0.6).
 
 # API quirks
 

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/ravelry.rb

@@ -4,6 +4,7 @@ require 'typhoeus'
 require 'ravelry/configuration'
 
 require 'ravelry/utils/build'
+require 'ravelry/utils/request'
 require 'ravelry/utils/utilities'
 
 require 'ravelry/author'
@@ -12,9 +13,10 @@ require 'ravelry/color_family'
 require 'ravelry/craft'
 require 'ravelry/data'
 require 'ravelry/misc'
+require 'ravelry/needle'
+require 'ravelry/needles'
 require 'ravelry/pack'
 require 'ravelry/pattern'
-require 'ravelry/pattern_needle'
 require 'ravelry/pattern_type'
 require 'ravelry/photo'
 require 'ravelry/printing'

data/lib/ravelry/misc.rb

@@ -1,5 +1,7 @@
 module Ravelry
 
+  # Handles API request for the `Misc` endpoints. Always returns an array of objects.
+  #
   module Misc
     extend self
 
@@ -8,17 +10,17 @@ module Ravelry
     # Returns an array of {Ravelry::ColorFamily} objects.
     #
     def color_families
-      request = Typhoeus::Request.get("https://api.ravelry.com/color_families.json", userpwd: "#{Ravelry.configuration.access_key}:#{Ravelry.configuration.personal_key}")
-      result = JSON.parse(request.response_body, {symbolize_names: true})
-      @data = result[:color_families]
-      @data.map { |d| ColorFamily.new(d) }
+      result = Utils::Request.get("color_families.json", :color_families)
+      result.map { |color_family| ColorFamily.new(color_family) }
     end
 
+    # Handles GET API call and parses JSON response for the `Misc#color_families` Ravelry endpoint.
+    #
+    # Returns an array of {Ravelry::ColorFamily} objects.
+    #
     def yarn_weights
-      request = Typhoeus::Request.get("https://api.ravelry.com/yarn_weights.json", userpwd: "#{Ravelry.configuration.access_key}:#{Ravelry.configuration.personal_key}")
-      result = JSON.parse(request.response_body, {symbolize_names: true})
-      @data = result[:yarn_weights]
-      @data.map { |d| YarnWeight.new(d) }
+      result = Utils::Request.get("yarn_weights.json", :yarn_weights)
+      result.map { |yarn_weight| YarnWeight.new(yarn_weight) }
     end
   end
 end

data/lib/ravelry/needle.rb

@@ -0,0 +1,74 @@
+module Ravelry
+
+  # The API endpoint for fetching `Needle` objects can be found in {Ravelry::Needles}.
+  #
+  # A `Needle` object can be created by several different endpoints but is currently only implemented in {Ravelry::Misc}.
+  #
+  class Needle
+    attr_reader :id, :metric, :metric_name, :hook, :name, :pretty_metric, :us, :description, :length, :needle_size_id, :type_name, :comment, :needle_type, :needle_type_id, :data
+    def initialize(data)
+      @data = data
+      @id = data[:id]
+      # Crochet hook size.
+      # Corresponding to this metric size, if one exists.
+      #
+      @hook = data[:hook]
+      # US size number corresponding to this metric size, if one exists
+      # 
+      @us = data[:us]
+      # Combination of US and metric.
+      # Example: "US 4  - 3.5 mm"
+      #
+      @name = data[:name]
+      # Metric designation for hook size.
+      #
+      @metric = data[:metric]
+      # Metric size for knitting needles (Integer or Float).
+      #
+      @metric_name = data[:metric_name]
+      # Metric size for knitting needles (pretty format).
+      #
+      @pretty_metric = data[:pretty_metric]
+
+      @description = data[:description]
+      @length = data[:length]
+      @needle_size_id = data[:needle_size_id]
+      @type_name = data[:type_name]
+      @needle_type = data[:needle_type]
+      @needle_type_id = data[:needle_type_id]
+      @comment = data[:comment]
+    end
+
+    # Takes the US size and turns it into a string.
+    # Example: "US 4"
+    #
+    def us_string
+      "US #{@us}".strip
+    end
+
+    # Takes the metric size and turns it into a string.
+    # Example: "3.5 mm"
+    #
+    def metric_string
+      "#{@metric} mm"
+    end
+
+    # Sets @type to 'knitting' or 'crochet'.
+    #
+    def type
+      if hook || data[:crochet]
+        'crochet'
+      else
+        'knitting'
+      end
+    end
+
+    def knitting?
+      type == 'knitting'
+    end
+
+    def crochet?
+      type == 'crochet'
+    end
+  end
+end

data/lib/ravelry/needles.rb

@@ -0,0 +1,35 @@
+module Ravelry
+
+  # Handles API request for the `Needles` endpoints. Always returns an array of {Ravelry::Needle} objects.
+  # 
+  module Needles
+    extend self
+
+    # Get available sizes for each needle type. If you don't pass an argument, you'll get all knitting needle and crochet hook sizes.
+    # 
+    # If you pass an argument (`'knitting'` or `'crochet'`), you will only get results that match that type.
+    # 
+    # Arguments: needle type (string, optional)
+    # 
+    def sizes(craft='')
+      result = Utils::Request.get("needles/sizes.json?craft=#{craft}", :needle_sizes)
+      result.map { |needle| Needle.new(needle) }
+    end
+
+    # Get needle types.
+    # 
+    def types
+      result = Utils::Request.get("needles/types.json", :needle_types)
+      result.map { |needle| Needle.new(needle) }
+    end
+
+    # Get needle records for an individual user.
+    # 
+    # Arguments: username (string, required)
+    # 
+    def list(username)
+      result = Utils::Request.get("people/#{username}/needles/list.json", :needle_records)
+      result.map { |needle| Needle.new(needle) }
+    end
+  end
+end

data/lib/ravelry/pattern.rb

@@ -2,7 +2,7 @@ module Ravelry
 
   # `Ravelry::Pattern` corresponds to Pattern objects in Ravelry.
   #
-  # This class requires your environment variables be set (see {file:README.md README}). API calls are authenticated using HTTP Basic Auth unless otherwise noted.
+  # This class requires your configuration variables be set (see {file:README.md README}). API calls are authenticated using HTTP Basic Auth unless otherwise noted.
   #
   # If your `pattern.data` is missing one of the attributes below, that method will return `nil`.
   #
@@ -64,7 +64,7 @@ module Ravelry
   # To create all associated objects at once, call the following method after initialization:
   #
   # ```ruby
-  # pattern.build_all_objects
+  # pattern.build
   # ```
   #
   # Note that this does not perform an API call: it creates the objects using the data returned from the initial `get` for your pattern object.
@@ -74,7 +74,7 @@ module Ravelry
   # * `pattern.author` - a {Ravelry::Author} object
   # * `pattern.categories` - an array of {Ravelry::Category} objects
   # * `pattern.craft` - a {Ravelry::Craft} object
-  # * `pattern.needles` - an array of {Ravelry::PatternNeedle} objects
+  # * `pattern.needles` - an array of {Ravelry::Needle} objects
   # * `pattern.packs` - array of {Ravelry::Pack} objects
   # * `pattern.photos` - an array of {Ravelry::Photo} objects
   # * `pattern.printings` - an array of {Raverly::Printing} objects
@@ -91,11 +91,11 @@ module Ravelry
     attr_reader :author, :categories, :craft, :needles, :packs, :photos, :printings, :type, :yarns, :yarn_weights
 
     # Handles GET API call and parses JSON response.
+    # 
+    # Corresponds to Ravelry API endpoint `Patterns#show`
     #
     def get
-      request = Typhoeus::Request.get("https://api.ravelry.com/patterns/#{@id}.json", userpwd: "#{Ravelry.configuration.access_key}:#{Ravelry.configuration.personal_key}")
-      result = JSON.parse(request.response_body, {symbolize_names: true})
-      @data = result[:pattern]
+      @data = Utils::Request.get("patterns/#{@id}.json", :pattern)
     end
 
     # Creates all objects associated with your pattern; returns nothing; sets `attr_readers`.

data/lib/ravelry/utils/build.rb

@@ -32,16 +32,16 @@ module Ravelry
       @craft = Craft.new(data[:craft])
     end
 
-    # Creates and returns an array of {Ravelry::PatternNeedle} objects.
+    # Creates and returns an array of {Ravelry::Needle} 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.
+    # See {Ravelry::Needle} for more information.
     #
     def self.needles(data)
       @needles = []
       data[:pattern_needle_sizes].each do |ndl|
-        @needles << PatternNeedle.new(ndl)
+        @needles << Needle.new(ndl)
       end
       @needles
     end

data/lib/ravelry/utils/request.rb

@@ -0,0 +1,14 @@
+module Ravelry
+  module Utils
+    module Request
+      extend self
+
+      def get(url, key)
+        request = Typhoeus::Request.get("https://api.ravelry.com/#{url}", userpwd: "#{Ravelry.configuration.access_key}:#{Ravelry.configuration.personal_key}")
+        data = JSON.parse(request.response_body, {symbolize_names: true})
+        return data[key] if key
+        return data
+      end
+    end
+  end
+end

data/lib/ravelry/version.rb

@@ -1,3 +1,3 @@
 module Ravelry
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/ravelry/{pattern_needle_spec.rb → needle_spec.rb}

@@ -1,20 +1,16 @@
 require_relative '../spec_helper'
 
-describe Ravelry::PatternNeedle do
+describe Ravelry::Needle do
   before do
-    @ndl = Ravelry::PatternNeedle.new(needle)
+    @ndl = Ravelry::Needle.new(needle)
     @data = needle
   end
 
   it 'creates an instance of Needle' do
-    expect(@ndl).to be_instance_of(Ravelry::PatternNeedle)
+    expect(@ndl).to be_instance_of(Ravelry::Needle)
   end
 
   context 'has and sets reader attributes for' do
-    it 'type' do
-      expect(@ndl.type).to eq('knitting')
-    end
-
     it 'hook' do
       expect(@ndl.hook).to eq(@data[:hook])
     end
@@ -26,10 +22,6 @@ describe Ravelry::PatternNeedle do
     it 'metric' do
       expect(@ndl.metric).to eq(@data[:metric])
     end
-
-    it 'knitting' do
-      expect(@ndl.knitting).to eq(@data[:name])
-    end
   end
 
   context 'class methods' do
@@ -37,7 +29,7 @@ describe Ravelry::PatternNeedle do
       ndl = { :hook=>"E", :us_steel=>"00", :name=>"US 4  - 3.5 mm",
       :crochet=>true, :metric=>3.5, :knitting=>false, :us=>"4 ",
       :id=>4 }
-      needle = Ravelry::PatternNeedle.new(ndl)
+      needle = Ravelry::Needle.new(ndl)
       expect(needle.type).to eq('crochet')
     end
 

data/spec/ravelry/needles_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../spec_helper'
+
+describe Ravelry::Needles do
+  context '#sizes' do
+    it 'should return an array of needles' do
+      result = Ravelry::Needles.sizes
+      expect(result.first).to be_instance_of(Ravelry::Needle)
+    end
+  end
+
+  context '#types' do
+    it 'should return an array of needles' do
+      result = Ravelry::Needles.types
+      expect(result.first).to be_instance_of(Ravelry::Needle)
+    end
+  end
+
+  context '#list' do
+    it 'should return an array of needles' do
+      result = Ravelry::Needles.list("feministy")
+      expect(result.first).to be_instance_of(Ravelry::Needle)
+    end
+  end
+end

data/spec/ravelry/utils/build_spec.rb

@@ -65,7 +65,7 @@ describe Ravelry::Build do
     end
 
     it 'returns an Array of Needle objects' do
-      expect(@needles[0]).to be_instance_of(Ravelry::PatternNeedle)
+      expect(@needles[0]).to be_instance_of(Ravelry::Needle)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ravelry
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Liz Abinante
@@ -76,9 +76,10 @@ files:
 - lib/ravelry/craft.rb
 - lib/ravelry/data.rb
 - lib/ravelry/misc.rb
+- lib/ravelry/needle.rb
+- lib/ravelry/needles.rb
 - lib/ravelry/pack.rb
 - lib/ravelry/pattern.rb
-- lib/ravelry/pattern_needle.rb
 - lib/ravelry/pattern_type.rb
 - lib/ravelry/photo.rb
 - lib/ravelry/printing.rb
@@ -86,6 +87,7 @@ files:
 - lib/ravelry/user.rb
 - lib/ravelry/user_site.rb
 - lib/ravelry/utils/build.rb
+- lib/ravelry/utils/request.rb
 - lib/ravelry/utils/utilities.rb
 - lib/ravelry/version.rb
 - lib/ravelry/yarn.rb
@@ -101,8 +103,9 @@ files:
 - spec/ravelry/craft_spec.rb
 - spec/ravelry/data_spec.rb
 - spec/ravelry/misc_spec.rb
+- spec/ravelry/needle_spec.rb
+- spec/ravelry/needles_spec.rb
 - spec/ravelry/pack_spec.rb
-- spec/ravelry/pattern_needle_spec.rb
 - spec/ravelry/pattern_spec.rb
 - spec/ravelry/pattern_type_spec.rb
 - spec/ravelry/photo_spec.rb
@@ -133,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby gem for accessing the Ravelry API.
@@ -148,8 +151,9 @@ test_files:
 - spec/ravelry/craft_spec.rb
 - spec/ravelry/data_spec.rb
 - spec/ravelry/misc_spec.rb
+- spec/ravelry/needle_spec.rb
+- spec/ravelry/needles_spec.rb
 - spec/ravelry/pack_spec.rb
-- spec/ravelry/pattern_needle_spec.rb
 - spec/ravelry/pattern_spec.rb
 - spec/ravelry/pattern_type_spec.rb
 - spec/ravelry/photo_spec.rb
@@ -160,3 +164,4 @@ test_files:
 - spec/ravelry/yarn_weight_spec.rb
 - spec/ravelry_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/ravelry/pattern_needle.rb

@@ -1,54 +0,0 @@
-module Ravelry
-
-  # The information used to create `Ravelry::PatternNeedle` objects comes from {Ravelry::Pattern} objects.
-  #
-  # You should not create `PatternNeedle` objects manually; they are all created–and owned–by a {Ravelry::Pattern}.
-  #
-  # Note that there are other API endpoints for Needles; this might not be the one that you're looking for.
-  #
-  # See {Ravelry::Pattern} for more information about `Pattern` objects.
-  #
-  class PatternNeedle
-
-    attr_reader :type, :hook, :us, :metric, :knitting
-
-    def initialize(needle)
-      @needle = needle
-      # Crochet hook size.
-      #
-      @hook = needle[:hook]
-      # US size for knitting needles (Integer or Float).
-      #
-      @us = needle[:us]
-      # Metric size for knitting needles (Integer or Float).
-      #
-      @metric = needle[:metric]
-      # Combination of US and metric.
-      # Example: "US 4  - 3.5 mm"
-      #
-      @knitting = needle[:name]
-    end
-
-    # Sets @type to 'knitting' or 'crochet'.
-    #
-    def type
-      @type = 'knitting' if @needle[:knitting]
-      @type = 'crochet' if @needle[:crochet]
-      @type
-    end
-
-    # Takes the US size and turns it into a sentence.
-    # Example: "US 4"
-    #
-    def us_string
-      "US #{@us}".strip
-    end
-
-    # Takes the metric size and turns it into a sentence.
-    # Example: "3.5 mm"
-    #
-    def metric_string
-      "#{@metric} mm"
-    end
-  end
-end