ravelry 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9132400df864b998861fc08da936fdafd7da5dc
-  data.tar.gz: ce313f70e9acb79289e801f5872e761d7a2a19af
+  metadata.gz: b59dc93738ed456de23da333441d63e0cc44bd8b
+  data.tar.gz: 78679aaf9e8a39d0a4041651d1e8e4403a089eab
 SHA512:
-  metadata.gz: 1adcd5d8930d86cfa2a948995fcf54b1251d8358b16d9c6783832e60c333ddfaf5197b7857256d899d69a9676cf261523eaf2b199c58cee4eb8b76c2e0346944
-  data.tar.gz: 0697d617a95f2f02f31a4a0b2598ebbe7caca22bbbf2fd51be5b6e4603483dc6c8a499de4d6a0caad8aca308a3a12b995634ef9d6925f1fc5724c05833e1b4f1
+  metadata.gz: e8b47e7535e1a7803f312286c32354ceabb614be9691eea5b690065e86d8d584b5f9c45cc9dc14aa2a688bb4e8e5fe31c54129c590799013a9e2032a2f66d3b6
+  data.tar.gz: b7a05c4f35c94f9b517258a6eda0c0eadeb07b0bd1e4c8cf08ac1ad1d7fe5030fe5c9c2479c6b8edeae3c4f13ee96ffda735e506705cd27c312e2608007a76b2

data/README.md

@@ -1,35 +1,38 @@
 # Ravelry
 
-_You are reading documentation for version: 0.0.7_
+_You are reading documentation for version: 0.0.8_
 
-[ ![Codeship Status for ArtCraftCode/ravelry](https://codeship.com/projects/fc6710e0-5719-0133-36cc-5ebc52a48109/status?branch=0.0.7)](https://codeship.com/projects/109462)
+[ ![Codeship Status for ArtCraftCode/ravelry](https://codeship.com/projects/fc6710e0-5719-0133-36cc-5ebc52a48109/status?branch=0.0.8)](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.
+The Ruby gem for accessing the Ravelry API painlessly, easily, and awesomely! This gem is actively being developed. **Be sure to check the branch for the version you're using.**
 
-To see what I am working on next, visit the project's [Trello board](https://trello.com/b/o8gs4cWI/ravelry).
+**Important and helpful links:**
 
-The Ruby gem for accessing the Ravelry API painlessly, easily, and awesomely.
-
-Ravelry API documentation is currently available [here](http://www.ravelry.com/api).
+- [Full gem documentation (version 0.0.8)](http://www.rubydoc.info/gems/ravelry/0.0.8)
+- [Changelog](https://github.com/ArtCraftCode/ravelry/blob/0.0.8/CHANGELOG.md)
+- [Project Trello board](https://trello.com/b/o8gs4cWI/ravelry)
+- [Ravelry API documentation](http://www.ravelry.com/api)
 
 ## API coverage
 
-See documentation for each class (or module) to see how to initialize the objects.
+See [documentation](http://www.rubydoc.info/gems/ravelry/0.0.8) 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`
+**Misc** | [current_user](http://www.ravelry.com/api#/_current_user) | `Ravelry::Misc.current_user`
 **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** | [comments](http://www.ravelry.com/api#patterns_comments) | `Ravelry::Pattern.comments`
 **Patterns** | [search](http://www.ravelry.com/api#patterns_search) | `Ravelry::Pattern.search`
 **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
 
-Welcome to a magical land where gems rule the world. To install, type:
+To install, type:
 
 ```
 gem install ravelry
@@ -40,16 +43,16 @@ Hooray! You now have a gem.
 Add to your `Gemfile`:
 
 ```ruby
-gem "ravelry", "~> 0.0.7"
+gem "ravelry", "~> 0.0.8"
 ```
 
-**I highly recommend pinning your version** because the gem is in active development and I _promise_ I will break shit.
+**I highly recommend pinning your version** because the gem is in active development and small changes and additions will be made regularly.
 
 Run `bundle install` and proceed as usual.
 
-## API keys
+# Configuration
 
-API keys must be configured in the gem setup. You can do this anywhere in your application before you make API calls using the gem.
+API keys *must* be configured in the gem setup. You can do this anywhere in your application before you make API calls using the gem.
 
 ```ruby
 Ravelry.configure do |config|
@@ -75,23 +78,7 @@ Ravelry.configuration.personal_key
 
 # Usage
 
-Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.0.7).
-
-# API quirks
-
-## Accessing pattern ids (for `Ravelry::Patterns`)
-
-To use the `Patterns#show` endpoint, you need the pattern id from Ravelry. You can use the pattern search API to search for the pattern name and get this information, but that is not yet implemented in the gem.
-
-In the meantime, navigate to a pattern page in Ravelry and open up the JavaScript console. Type this in:
-
-```javascript
-$$('.difficulty').first().id
-```
-
-You should see something like this: ```"pattern_419443_difficulty_score"```.
-
-```419443``` is your pattern id.
+Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.0.8).
 
 # Conventions
 
@@ -124,7 +111,7 @@ pattern.difficulty_average_integer
 
 Hey! You want to contribute? That is super, super awesome. Visit the project's [Trello board](https://trello.com/b/o8gs4cWI/ravelry) to see what's coming up next or what is already in progress.
 
-Send me a pull request! Note that your pull request will not be accepted if you don't write tests **and documentation** for your code (the test part kind of goes without saying, but I wanted to make sure that you knew about it and the documentation).
+Send me a pull request! Please write tests, **documentation** for your code (the test part kind of goes without saying, but I wanted to make sure that you knew about it and the documentation), and update the changelog with your additions under the next unreleased version.
 
 To run specs locally, simply `bundle` and then run `rpsec`.
 

data/lib/ravelry.rb

@@ -10,6 +10,7 @@ require 'ravelry/utils/utilities'
 require 'ravelry/author'
 require 'ravelry/category'
 require 'ravelry/color_family'
+require 'ravelry/comment'
 require 'ravelry/craft'
 require 'ravelry/data'
 require 'ravelry/misc'

data/lib/ravelry/comment.rb

@@ -0,0 +1,34 @@
+module Ravelry
+
+  # The information used to create `Ravelry::Comment` comes from {Ravelry::Pattern} objects.
+  #
+  # You should not create `Comment` objects manually; they are all created–and owned by–by a {Ravelry::Pattern}.
+  #
+  # See {Ravelry::Pattern} for more information about `Pattern` objects.
+  #
+  class Comment
+    attr_reader :highlighted_project, :user, :html, :id
+
+    # Creates new `Comment` from Ravelry API Pattern Comment attributes.
+    #
+    # All class variables are readonly.
+    #
+    def initialize(data)
+      @data = data
+      @user = Ravelry::User.new
+      @user.data = data[:user]
+      @highlighted_project = data[:highlighted_project]      
+      @html = data[:html]
+      @id = data[:id]
+    end
+
+    def replies
+      @reply_list ||= []
+      return @reply_list if @reply_list.any?
+      @data[:replies].map do |reply|
+        @reply_list << Ravelry::Comment.new(reply)
+      end
+    end
+  end
+
+end

data/lib/ravelry/misc.rb

@@ -22,5 +22,18 @@ module Ravelry
       result = Utils::Request.get("yarn_weights.json", :yarn_weights)
       result.map { |yarn_weight| YarnWeight.new(yarn_weight) }
     end
+
+    # Make a GET API call for the current authenticated user. Without the OAuth setup, this will just be you, the requester.
+    # 
+    # Returns a {Ravelry::User} object.
+    # 
+    # Note: the returned `User` won't have everything from a standard {Ravelry::User} request, but you will have the information necessary to make a request for the full profile if desired.
+    # 
+    def current_user
+      result = Utils::Request.get("current_user.json", :user)
+      user = Ravelry::User.new
+      user.data = result
+      return user
+    end
   end
 end

data/lib/ravelry/pattern.rb

@@ -22,6 +22,17 @@ module Ravelry
   # ```
   #
   # After calling `get`, you have access to all of the class methods below.
+  # 
+  # If you do not have the pattern ID, you may use the permalink:
+  # 
+  # Ravelry URL: http://www.ravelry.com/patterns/library/traveling-woman
+  # 
+  # Request:
+  # 
+  # ```ruby
+  # pattern = Ravelry::Pattern.new
+  # pattern.permalink_get('traveling-woman')
+  # ```
   #
   # ##Initializing with an id
   #
@@ -96,6 +107,13 @@ module Ravelry
   #
   class Pattern < Data
 
+    COMMENT_OPTIONS = {
+      sort: ['time', 'helpful', 'time_', 'helpful_'],
+      page_size: 25,
+      include: ['highlighted_project'],
+      page: 1
+    }
+
     include Build
 
     attr_reader :author, :categories, :craft, :needles, :packs, :photos, :printings, :type, :yarns, :yarn_weights
@@ -108,6 +126,46 @@ module Ravelry
       @data = Utils::Request.get("patterns/#{@id}.json", :pattern)
     end
 
+    # Alternative method for the GET API call.
+    # 
+    # Corresponds to Ravelry API endpoint `Patterns#show`
+    # 
+    # Uses the pattern's Ravelry permalink instead of ID. Useful if you don't know the ID of a pattern, but have the permalink.
+    # 
+    # **Example**
+    # 
+    # Ravelry URL: http://www.ravelry.com/patterns/library/traveling-woman
+    # 
+    # Request:
+    # 
+    # ```ruby
+    # pattern = Ravelry::Pattern.new
+    # pattern.permalink_get('traveling-woman')
+    # ```
+    # 
+    def permalink_get(permalink)
+      @data = Utils::Request.get("patterns/#{permalink}.json", :pattern)
+    end
+
+    # Get the list of comments on a pattern object.
+    # 
+    # To query comments for a pattern you haven't fetched yet, without fetching the pattern:
+    # 
+    # ```ruby
+    # pattern = Ravelry::Pattern.new
+    # pattern.id = "000000"
+    # pattern.comments
+    # ```
+    # 
+    # To query comments for a pattern you've already fetched, follow the steps above and call `pattern.comments`.
+    # 
+    def comments(options={})
+      @comment_list ||= []
+      return @comment_list if @comment_list.any?
+
+      fetch_comments(options)
+    end
+
     # Search for patterns.
     #
     # Corresponds to Ravelry API endpoint `Patterns#search`
@@ -275,7 +333,7 @@ module Ravelry
     #
     # I've included this method in case you want to have more control over how your author information is displayed.
     #
-    # See {#build_authors} for more information about directly accessing author information.
+    # See {Ravelry::Author} for more information about directly accessing author information.
     #
     def pattern_author
       data[:pattern_author]
@@ -285,7 +343,7 @@ module Ravelry
     #
     # This method is included so you can access the information directly.
     #
-    # See {#build_categories} for more information about directly accessing category information.
+    # See {Ravelry::Category} for more information about directly accessing category information.
     #
     def pattern_categories_raw
       data[:pattern_categories]
@@ -296,7 +354,7 @@ module Ravelry
     #
     # This method is included so you can access the information directly.
     #
-    # See {#build_needles} for more information about directly accessing category information.
+    # See {Ravelry::Needle} for more information about directly accessing category information.
     #
     def pattern_needle_sizes_raw
       data[:pattern_needle_sizes]
@@ -306,7 +364,7 @@ module Ravelry
     #
     # This method is included so you can access the information directly.
     #
-    # See {#build_pattern_type} for more information about directly accessing category information.
+    # See {Ravelry::Needle} for more information about directly accessing category information.
     #
     def pattern_type_raw
       data[:pattern_type]
@@ -328,7 +386,7 @@ module Ravelry
     #
     # This method is included so you can access the information directly.
     #
-    # See {#build_photos} for more information about directly accessing category information.
+    # See {Ravelry::Photo} for more information about directly accessing category information.
     #
     def photos_raw
       data[:photos]
@@ -423,5 +481,16 @@ module Ravelry
     def yarn_weight_description
       data[:yarn_weight_description]
     end
+
+    private
+    def fetch_comments(options)
+      options.keep_if { |key| COMMENT_OPTIONS.keys.include?(key) }
+      if options[:per_page]
+        options[:per_page] = 100 if options[:per_page] > 100
+      end
+
+      comment_data = Utils::Request.get("patterns/#{@id}/comments.json", :comments, options)
+      comment_data.map { |comment| Comment.new(comment) }
+    end
   end
 end

data/lib/ravelry/user.rb

@@ -67,11 +67,11 @@ module Ravelry
     end
 
     def about_me
-      @data['about_me']
+      @data[:about_me]
     end
 
     def about_me_html
-      @data['about_me_html']
+      @data[:about_me_html]
     end
 
     def author
@@ -79,45 +79,50 @@ module Ravelry
     end
 
     def fave_colors
-      @data['fave_colors']
+      @data[:fave_colors]
     end
 
     def fave_curse
-      @data['fave_curse']
+      @data[:fave_curse]
     end
 
     def first_name
-      @data['first_name']
+      @data[:first_name]
     end
 
     def large_photo_url
-      @data['large_photo_url']
+      @data[:large_photo_url]
     end
 
     def location
-      @data['location']
+      @data[:location]
     end
 
     def photo_url
-      @data['photo_url']
+      @data[:photo_url]
     end
 
     def small_photo_url
-      @data['small_photo_url']
+      @data[:small_photo_url]
     end
 
     def tiny_photo_url
-      @data['tiny_photo_url']
+      @data[:tiny_photo_url]
     end
 
     def username
-      @data['username']
+      @data[:username]
     end
 
     # ID from the Ravelry database.
     # 
     def _id
-      @data['id']
+      @data[:id]
+    end
+
+    private
+    def build
+      @id = @data[:id] unless @id
     end
   end
 end

data/lib/ravelry/version.rb

@@ -1,3 +1,3 @@
 module Ravelry
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/ravelry/misc_spec.rb

@@ -22,4 +22,33 @@ describe Ravelry::Misc do
       expect(result.first).to be_instance_of(Ravelry::YarnWeight)
     end
   end
+
+  context '#current_user' do
+    before do
+      @user = Ravelry::Misc.current_user
+    end
+
+    it 'should return a user' do
+      expect(@user).to be_instance_of(Ravelry::User)
+    end
+
+    it 'should be missing #about_me' do
+      expect(@user.about_me).to be_nil
+    end
+
+    it 'should have photos' do
+      expect(@user.photo_url).to be
+      expect(@user.small_photo_url).to be
+      expect(@user.tiny_photo_url).to be
+      expect(@user.large_photo_url).to be
+    end
+
+    it 'should have an id' do
+      expect(@user.id).to be
+    end
+
+    it 'should have a username' do
+      expect(@user.username).to be
+    end
+  end
 end

data/spec/ravelry/pattern_spec.rb

@@ -28,6 +28,26 @@ describe Ravelry::Pattern do
     end
   end
 
+  context "#permalink_get" do
+    before do
+      pattern = Ravelry::Pattern.new
+      pattern.permalink_get("traveling-woman")
+      @api = pattern
+    end
+
+    it 'should succeed' do
+      expect(@api).to be
+    end
+
+    it 'should return a pattern' do
+      expect(@api.data).to be
+    end
+
+    it 'should return a hash' do
+      expect(@api.data).to be_kind_of(Hash)
+    end
+  end
+
   context '#search' do
     let(:result) { Ravelry::Pattern.search('hello') }
     before { stub_patterns_search }
@@ -67,6 +87,16 @@ describe Ravelry::Pattern do
     end
   end
 
+  context '#comments' do
+    before do
+        @pattern = p_initialize_paid_with_fetch
+    end
+
+    it 'creates comments' do
+      expect(@pattern.comments[0]).to be_instance_of(Ravelry::Comment)
+    end
+  end
+
   context 'class methods' do
     before do
       @api = p_initialize_with_data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ravelry
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Liz Abinante
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
 description: Ruby gem for accessing the Ravelry API painlessly, easily, and awesomely.
 email: me@liz.codes
 executables: []
@@ -65,6 +107,7 @@ files:
 - lib/ravelry/author.rb
 - lib/ravelry/category.rb
 - lib/ravelry/color_family.rb
+- lib/ravelry/comment.rb
 - lib/ravelry/configuration.rb
 - lib/ravelry/craft.rb
 - lib/ravelry/data.rb