ravelry 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4dcc5188a55d99529661b1bde3859b5ea1351da5
-  data.tar.gz: c526d13944150e9464254ea8d7a3a8296249d1eb
+  metadata.gz: 9109931a9b33ea14a93c82f5fd81d4ad1f2d47ea
+  data.tar.gz: 1a5fd7b46c9049d75f5255772f27d667e39ffe53
 SHA512:
-  metadata.gz: 8ecae4dc95317877ea9f9e80d5ca9ff49adab6bd79a95da7dc634eb3b49d901348de809d5f48268c9ee64741b4dbece5f9c38cc5c045a15c33edd68d8d2b1be1
-  data.tar.gz: 1bb66e52e6f80a1512586974e4841233bca9d89226fb369d63cb37699ecf85b9ccdd1fa39662940fb8457c6a5f3416d5645c436496076ff217bfe3203ecee3c6
+  metadata.gz: bac3a69cd317f41303aeb7a8accd7b85c1b64d1f549033906aadcd3100ef8259b2cf0d3403b7fa8ecc6d71d40eb1d47ec054ed096a131b26ea950c8783d5996d
+  data.tar.gz: 7a45bd027bf36ed7a8ff3f078132ef1e39148b8de8ecad9a5367dec2fd1f4a5ac9581ac1b92ece8080607a0f5c770c0ec206dfa3c02652cb1108320ead0a04e8

data/README.md

@@ -1,10 +1,8 @@
 # Ravelry
 
-_You are reading documentation for version: 0.0.4_
+_You are reading documentation for version: 0.0.5_
 
-You may be wondering what happened to 0.0.3. Apparently, I don't understand how publishing works. LOL WHOOOOOPS.
-
-[ ![Codeship Status for ArtCraftCode/ravelry](https://codeship.com/projects/fc6710e0-5719-0133-36cc-5ebc52a48109/status?branch=0.0.4)](https://codeship.com/projects/109462)
+[ ![Codeship Status for ArtCraftCode/ravelry](https://codeship.com/projects/fc6710e0-5719-0133-36cc-5ebc52a48109/status?branch=0.0.5)](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.
 
@@ -18,6 +16,8 @@ Ravelry API documentation is currently available [here](http://www.ravelry.com/a
 
 * [`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`
 
 # Installation
 
@@ -32,7 +32,7 @@ Hooray! You now have a gem.
 Add to your `Gemfile`:
 
 ```ruby
-gem "ravelry", "~> 0.0.4"
+gem "ravelry", "~> 0.0.5"
 ```
 
 **I highly recommend pinning your version** because the gem is in active development and I _promise_ I will break shit.
@@ -67,7 +67,7 @@ Ravelry.configuration.personal_key
 
 # Usage
 
-Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.0.4).
+Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.0.5).
 
 # API quirks
 

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/ravelry.rb

@@ -8,8 +8,10 @@ require 'ravelry/utils/utilities'
 
 require 'ravelry/author'
 require 'ravelry/category'
+require 'ravelry/color_family'
 require 'ravelry/craft'
 require 'ravelry/data'
+require 'ravelry/misc'
 require 'ravelry/pack'
 require 'ravelry/pattern'
 require 'ravelry/pattern_needle'

data/lib/ravelry/author.rb

@@ -1,20 +1,20 @@
 module Ravelry
 
   # There is no API access point for PatternAuthors. The information used to create `Ravelry::Author` comes from {Ravelry::Pattern} objects.
-  # 
+  #
   # You should not create `Author` objects manually; they are all created–and owned by–by a {Ravelry::Pattern}.
-  # 
+  #
   # See {Ravelry::Pattern} for more information about `Pattern` objects.
-  # 
+  #
   # This does not inherit from {Ravelry::Data} because it doesn't have a corresponding API endpoint.
-  # 
+  #
   class Author
     attr_reader :id, :name, :permalink, :patterns_count, :favorites_count
 
     # Creates new `Author` from Ravelry API PatternAuthor attributes.
-    # 
+    #
     # All class variables are readonly.
-    # 
+    #
     def initialize(pattern_author)
       @id = pattern_author[:id]
       @name = pattern_author[:name]

data/lib/ravelry/color_family.rb

@@ -0,0 +1,23 @@
+module Ravelry
+
+  # The API endpoint for fetching `ColorFamilies` can be found in {Ravelry::Misc}.
+  #
+  # A `ColorFamily` object can be created by several different endpoints but is currently only implemented in {Ravelry::Misc}.
+  #
+  class ColorFamily
+    attr_reader :id, :name, :permalink, :spectrum_order, :color
+
+    # Creates new `ColorFamily` from Ravelry API ColorFamily attributes.
+    #
+    # All class variables are readonly.
+    #
+    def initialize(color_family)
+      @id = color_family[:id]
+      @color = color_family[:color]
+      @permalink = color_family[:permalink]
+      @name = color_family[:name]
+      @spectrum_order = color_family[:spectrum_order]
+    end
+  end
+
+end

data/lib/ravelry/misc.rb

@@ -0,0 +1,24 @@
+module Ravelry
+
+  module Misc
+    extend self
+
+    # Handles GET API call and parses JSON response for the `Misc#color_families` Ravelry endpoint.
+    #
+    # 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) }
+    end
+
+    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) }
+    end
+  end
+end

data/lib/ravelry/pattern.rb

@@ -22,17 +22,17 @@ module Ravelry
   # ```
   #
   # After calling `get`, you have access to all of the class methods below.
-  # 
+  #
   # ##Initializing with an id
-  # 
+  #
   # Optionally, you can initialize with an id:
-  # 
+  #
   # ```ruby
   # pattern = Ravelry::Pattern.new(id)
   # ```
-  # 
+  #
   # And then run your get request:
-  # 
+  #
   # ```ruby
   # pattern.get
   # ```
@@ -49,7 +49,7 @@ module Ravelry
   # You now have access to all class methods for your pattern. Be warned: if you run `get` again, you will override your data with fresh information from the API call.
   #
   # # Pattern data
-  # 
+  #
   # After you have pattern data from the API, you have access to all of the pattern attributes through the class methods (see documentation). Example:
   #
   # ```ruby

data/lib/ravelry/version.rb

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

data/ravelry.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name = "ravelry"
   spec.version = Ravelry::VERSION
   spec.authors = ["Liz Abinante"]
-  spec.date = "2015-10-17"
+  spec.date = "2015-11-10"
   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"

data/spec/ravelry/misc_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../spec_helper'
+
+describe Ravelry::Misc do
+  context '#color_families' do
+    it 'should return an array of color families' do
+      result = Ravelry::Misc.color_families
+      expect(result.first).to be_instance_of(Ravelry::ColorFamily)
+    end
+  end
+
+  context '#yarn_weights' do
+    it 'should return an array of color families' do
+      result = Ravelry::Misc.yarn_weights
+      expect(result.first).to be_instance_of(Ravelry::YarnWeight)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ravelry
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Liz Abinante
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-17 00:00:00.000000000 Z
+date: 2015-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,9 +71,11 @@ files:
 - lib/ravelry.rb
 - lib/ravelry/author.rb
 - lib/ravelry/category.rb
+- lib/ravelry/color_family.rb
 - lib/ravelry/configuration.rb
 - lib/ravelry/craft.rb
 - lib/ravelry/data.rb
+- lib/ravelry/misc.rb
 - lib/ravelry/pack.rb
 - lib/ravelry/pattern.rb
 - lib/ravelry/pattern_needle.rb
@@ -98,6 +100,7 @@ files:
 - spec/ravelry/category_spec.rb
 - spec/ravelry/craft_spec.rb
 - spec/ravelry/data_spec.rb
+- spec/ravelry/misc_spec.rb
 - spec/ravelry/pack_spec.rb
 - spec/ravelry/pattern_needle_spec.rb
 - spec/ravelry/pattern_spec.rb
@@ -130,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby gem for accessing the Ravelry API.
@@ -144,6 +147,7 @@ test_files:
 - spec/ravelry/category_spec.rb
 - spec/ravelry/craft_spec.rb
 - spec/ravelry/data_spec.rb
+- spec/ravelry/misc_spec.rb
 - spec/ravelry/pack_spec.rb
 - spec/ravelry/pattern_needle_spec.rb
 - spec/ravelry/pattern_spec.rb
@@ -156,4 +160,3 @@ test_files:
 - spec/ravelry/yarn_weight_spec.rb
 - spec/ravelry_spec.rb
 - spec/spec_helper.rb
-has_rdoc: