ravelry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0726ba5d5561d16af2180b2cfaf25a7fe90c1773
+  data.tar.gz: 6fec858f6080353788ad179e54270d4af4580783
+SHA512:
+  metadata.gz: 88901547a84900f2705574fa54adec93dea93fbeb9521d5f4aa32004fc610ae44f9ea164d9714c2dc669eda9f5d80ed44027a70e6ef7c37e35fd5b8356e4efe5
+  data.tar.gz: a399b5db5924138a4bf0c7c9a0a1af36d7379aae57a9ae4c10a15f9dd874745f56a8a454e662414febdb8df8bc7819e4642403738fdf22f86cbd746e28581cdc

data/.gitignore

@@ -0,0 +1,8 @@
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gem "typhoeus", "~> 0.6"
+
+group :development do
+  gem "rspec", "~> 2.14.1"
+  gem "bundler"
+  gem "yard"
+  gem "redcarpet"
+end
+
+group :test do
+	gem "rake"
+  gem "pry"
+  gem "pry-nav"
+end

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ethon (0.7.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.6)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rake (10.1.1)
+    redcarpet (3.0.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    slop (3.6.0)
+    typhoeus (0.6.9)
+      ethon (>= 0.7.1)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  pry
+  pry-nav
+  rake
+  redcarpet
+  rspec (~> 2.14.1)
+  typhoeus (~> 0.6)
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Liz Abinante
+
+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,112 @@
+# Ravelry
+
+_You are reading documentation for version: 0.0.1_
+
+[ ![Codeship Status for ArtCraftCode/ravelry](https://codeship.com/projects/fc6710e0-5719-0133-36cc-5ebc52a48109/status?branch=0.0.1)](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.
+
+To see what I am working on next, visit the project's [Trello board](https://trello.com/b/o8gs4cWI/ravelry).
+
+The Ruby gem for accessing the Ravelry API painlessly, easily, and awesomely.
+
+Ravelry API documentation is currently available [here](http://www.ravelry.com/api).
+
+## API coverage
+
+* `Patterns#show` (`GET`)
+
+# Installation
+
+Welcome to a magical land where gems rule the world. To install, type:
+
+```
+gem install ravelry
+```
+
+Hooray! You now have a gem.
+
+Add to your `Gemfile`:
+
+```
+gem "ravelry", "~> 0.0.1"
+```
+
+**I highly recommend pinning your version** because the gem is in active development and I _promise_ I will break shit.
+
+Run `bundle install` and proceed as usual.
+
+## API keys
+
+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|
+  config.access_key = ''
+  config.secret_key = ''
+  config.personal_key = ''
+end
+```
+
+* `config.access_key` - your Ravelry access key
+* `config.secret_key` - your Ravelry secret key
+* `config.personal_key` - wait for it! Your Ravelry personal key; primarily used for OAuth (not yet implemented in the gem)
+
+Getting these keys requires a (free) Ravelry account and that you agree to the terms of use for the API.
+
+# Usage
+
+Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.0.1).
+
+# 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.
+
+# Conventions
+
+This gem makes use of several conventions that are worth noting on a global scale.
+
+## Method names ending with `_count` return integers.
+
+Example:
+
+```ruby
+pattern.comments_count
+# => 4
+```
+
+## Method names ending with `_float`, `_integer`, etc return that object type.
+
+Float to Integer conversions are done using round(0).
+
+Example:
+
+```ruby
+pattern.difficulty_average_float
+# => 4.666666667
+
+pattern.difficulty_average_integer
+# => 5
+```
+
+# Contributing
+
+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).
+
+To run specs locally, simply `bundle` and then run `rpsec`.
+
+Documentation is generated by YARD and is producted using inline comments. Comments use Markdown syntax. You can run `yard server` to get a live server of documentation while you're working :)

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/ravelry.rb

@@ -0,0 +1,39 @@
+require 'json'
+require 'typhoeus'
+
+require 'ravelry/configuration'
+
+require 'ravelry/utils/build'
+require 'ravelry/utils/utilities'
+
+require 'ravelry/author'
+require 'ravelry/category'
+require 'ravelry/craft'
+require 'ravelry/data'
+require 'ravelry/pack'
+require 'ravelry/pattern'
+require 'ravelry/pattern_needle'
+require 'ravelry/pattern_type'
+require 'ravelry/photo'
+require 'ravelry/printing'
+require 'ravelry/yarn'
+require 'ravelry/yarn_weight'
+
+# Parent grouping for all classes.
+module Ravelry
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/ravelry/author.rb

@@ -0,0 +1,27 @@
+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]
+      @permalink = pattern_author[:permalink]
+      @patterns_count = pattern_author[:patterns_count]
+      @favorites_count = pattern_author[:favorites_count]
+    end
+  end
+
+end

data/lib/ravelry/category.rb

@@ -0,0 +1,57 @@
+module Ravelry
+
+  # There is no API access point for PatternCategories. The information used to create `Ravelry::Category` comes from {Ravelry::Pattern} objects.
+  #
+  # You should not create `Category` 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 Category
+    attr_reader :name, :permalink, :parent_name, :parent_permalink, :grandparent_name, :grandparent_permalink, :greatgrandparent_name, :greatgrandparent_permalink
+
+    # Creates new `Category` from Ravelry API PatternCategories attributes up to the great grandparent level
+    #
+    # All class variables are readonly.
+    #
+    def initialize(category)
+      @name = category[:name]
+      @permalink = category[:permalink]
+      @category = category
+      set_relatives
+    end
+
+    protected
+    # Returns parent name and sets parent attributes from existing `data`.
+    def parent
+      if @category[:parent]
+        @parent_permalink = @category[:parent][:permalink]
+        @parent_name = @category[:parent][:name]
+      end
+    end
+
+    # Returns parent name and sets grandparent attributes from existing `data`.
+    def grandparent
+      if @category[:parent][:parent]
+        @grandparent_permalink = @category[:parent][:parent][:permalink]
+        @grandparent_name = @category[:parent][:parent][:name]
+      end
+    end
+
+    # Returns parent name and sets greatgrandparent attributes from existing `data`.
+    def greatgrandparent
+      if @category[:parent][:parent][:parent]
+        @greatgrandparent_permalink = @category[:parent][:parent][:parent][:permalink]
+        @greatgrandparent_name = @category[:parent][:parent][:parent][:name]
+      end
+    end
+
+    private
+    def set_relatives
+      parent if @category[:parent]
+      grandparent if @category[:parent][:parent]
+      greatgrandparent if @category[:parent][:parent][:parent]
+    end
+  end
+end

data/lib/ravelry/configuration.rb

@@ -0,0 +1,11 @@
+module Ravelry
+  class Configuration
+    attr_accessor :access_key, :secret_key, :personal_key
+
+    def initialize
+      @access_key = nil
+      @secret_key = nil
+      @personal_key = nil
+    end
+  end
+end

data/lib/ravelry/craft.rb

@@ -0,0 +1,19 @@
+module Ravelry
+
+  # The information used to create `Ravelry::Craft` currently comes from {Ravelry::Pattern} objects.
+  #
+  # You should not create `Craft` objects manually; they are all created–and owned–by a {Ravelry::Pattern}.
+  #
+  # See {Ravelry::Pattern} for more information about `Pattern` objects.
+  #
+  class Craft
+
+    attr_reader :permalink, :name
+
+    def initialize(data)
+      @permalink = data[:permalink]
+      @name = data[:name]
+    end
+  end
+end
+

data/lib/ravelry/data.rb

@@ -0,0 +1,25 @@
+module Ravelry
+
+  # Parent class that controls initialization and fetching for API objects.
+  class Data
+    attr_accessor :id
+    attr_reader :data
+
+    def initialize(id=nil)
+      @id = id
+    end
+
+    def data=(d)
+      @data = d
+      build
+      self
+    end
+
+    private
+    # Determines if a GET request needs to be made.
+    def get?
+      @id && !@data
+    end
+  end
+
+end

data/lib/ravelry/pack.rb

@@ -0,0 +1,135 @@
+module Ravelry
+
+  # The information used to create `Ravelry::Pack` 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 Pack < Data
+
+    def build; end
+
+    # Gets quantity_description  from existing `data`.
+    def quantity_description
+      data[:quantity_description]
+    end
+    
+    # Gets yarn_id from existing `data`.
+    def yarn_id
+      data[:yarn_id]
+    end
+    
+    # Gets total_grams from existing `data`.
+    def total_grams
+      data[:total_grams]
+    end
+    
+    # Gets project_id from existing `data`.
+    def project_id
+      data[:project_id]
+    end
+    
+    # Gets shop_id from existing `data`.
+    def shop_id
+      data[:shop_id]
+    end
+    
+    # Gets prefer_metric_weight from existing `data`.
+    def prefer_metric_weight
+      data[:prefer_metric_weight]
+    end
+    
+    # Gets prefer_metric_length from existing `data`.
+    def prefer_metric_length
+      data[:prefer_metric_length]
+    end
+    
+    # Gets ounces_per_skein from existing `data`.
+    def ounces_per_skein
+      data[:ounces_per_skein]
+    end
+    
+    # Gets dye_lot from existing `data`.
+    def dye_lot
+      data[:dye_lot]
+    end
+    
+    # Gets skeins from existing `data`.
+    def skeins
+      data[:skeins]
+    end
+    
+    # Gets id from existing `data`.
+    def id
+      data[:id]
+    end
+    
+    # Gets grams_per_skein from existing `data`.
+    def grams_per_skein
+      data[:grams_per_skein]
+    end
+    
+    # Gets color_family_id from existing `data`.
+    def color_family_id
+      data[:color_family_id]
+    end
+    
+    # Gets shop_name from existing `data`.
+    def shop_name
+      data[:shop_name]
+    end
+    
+    # Gets total_meters from existing `data`.
+    def total_meters
+      data[:total_meters]
+    end
+    
+    # Gets stash_id from existing `data`.
+    def stash_id
+      data[:stash_id]
+    end
+    
+    # Gets total_ounces from existing `data`.
+    def total_ounces
+      data[:total_ounces]
+    end
+    
+    # Gets primary_pack_id from existing `data`.
+    def primary_pack_id
+      data[:primary_pack_id]
+    end
+    
+    # Gets personal_name from existing `data`.
+    def personal_name
+      data[:personal_name]
+    end
+    
+    # Gets colorway from existing `data`.
+    def colorway
+      data[:colorway]
+    end
+    
+    # Gets meters_per_skein from existing `data`.
+    def meters_per_skein
+      data[:meters_per_skein]
+    end
+    
+    # Gets yarn_name from existing `data`.
+    def yarn_name
+      data[:yarn_name]
+    end
+    
+    # Gets yards_per_skein from existing `data`.
+    def yards_per_skein
+      data[:yards_per_skein]
+    end
+    
+    # Gets total_yards from existing `data`.
+    def total_yards
+      data[:total_yards]
+    end
+
+  end
+
+end