ravelry 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a926a75405032fc909ee8df1a74c3ebbf947f113
-  data.tar.gz: e642b941fedf2f5898b67708bb5bdbb17cce4fe0
+  metadata.gz: 25a41c11df25b2d4a67b928fb0b4c9d51667e804
+  data.tar.gz: c8b6c5d8bbcb91a209b850e91494000c9e3a8880
 SHA512:
-  metadata.gz: a87301d42b07e5d4dd69443ebe0a33f8aa12b38997f968ce378895f7967e9a00419c4835264ade5c23053836079bdd7dce33d7f65e72c0c73ea79a14f55e49e2
-  data.tar.gz: 52a1201b777a686ceb5b1c5ab6fd691ef12bd147059d3814a3f1312dd1b67213e31323b5ef27718886b822d8ef1e7fdf69788359af42f9108d63af085213d133
+  metadata.gz: fc78ade45ca85b3b9d9582e7592b97192194407ff4ca396e729274dc38c8682b6092e9f50fa3f375e7091c850083b2bf81f60a904ce426db7fc342e0baaaffac
+  data.tar.gz: 88a307f89f51096792082eac8234cd5b8ec92a44d8ad651443828db671f97d4d8383251abea1709bfb25acc7aec8f44b98bd68dfe80fbddf05fac60b898e09aa

data/CODE_OF_CONDUCT.md

@@ -1,24 +1,41 @@
-# Contributor Code of Conduct
+# Contributor Covenant 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.
+## Our Pledge
 
-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.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
@@ -26,25 +43,32 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-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.
+## Scope
 
 This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at [INSERT EMAIL ADDRESS]. All
+reported by contacting the project team at me@liz.codes. All
 complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
 
+## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -1,21 +1,21 @@
 # Ravelry
 
-_You are reading documentation for version: 0.0.8_
+_You are reading documentation for version: 0.1.0_
 
-[ ![Codeship Status for ArtCraftCode/ravelry](https://codeship.com/projects/fc6710e0-5719-0133-36cc-5ebc52a48109/status?branch=0.0.8)](https://codeship.com/projects/109462)
+[ ![Codeship Status for ArtCraftCode/ravelry](https://codeship.com/projects/fc6710e0-5719-0133-36cc-5ebc52a48109/status?branch=0.1.0)](https://codeship.com/projects/109462)
 
 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.**
 
 **Important and helpful links:**
 
-- [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)
+- [Full gem documentation (version 0.1.0)](http://www.rubydoc.info/gems/ravelry/0.1.0)
+- [Changelog](https://github.com/ArtCraftCode/ravelry/blob/0.1.0/CHANGELOG.md)
 - [Project Trello board](https://trello.com/b/o8gs4cWI/ravelry)
 - [Ravelry API documentation](http://www.ravelry.com/api)
 
 ## API coverage
 
-See [documentation](http://www.rubydoc.info/gems/ravelry/0.0.8) for each class (or module) to see how to initialize the objects.
+See [documentation](http://www.rubydoc.info/gems/ravelry/0.1.0) for each class (or module) to see how to initialize the objects.
 
 API | Endpoint | Ravelry gem class / module
 ----|----------|------------------
@@ -43,7 +43,7 @@ Hooray! You now have a gem.
 Add to your `Gemfile`:
 
 ```ruby
-gem "ravelry", "~> 0.0.8"
+gem "ravelry", "~> 0.1.0"
 ```
 
 **I highly recommend pinning your version** because the gem is in active development and small changes and additions will be made regularly.
@@ -59,12 +59,14 @@ Ravelry.configure do |config|
   config.access_key = ''
   config.secret_key = ''
   config.personal_key = ''
+  config.callback_url = ''
 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)
+* `config.callback_url` - for OAuth, the callback url for your authentication requests
 
 Getting these keys requires a (free) Ravelry account and that you agree to the terms of use for the API.
 
@@ -74,11 +76,12 @@ The keys are available to you throughout your application as:
 Ravelry.configuration.access_key
 Ravelry.configuration.secret_key
 Ravelry.configuration.personal_key
+Ravelry.configuration.callback_url
 ```
 
 # Usage
 
-Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.0.8).
+Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.1.0).
 
 # Conventions
 

data/lib/ravelry.rb

@@ -2,6 +2,7 @@ require 'json'
 require 'typhoeus'
 
 require 'ravelry/configuration'
+require 'ravelry/errors/configuration'
 
 require 'ravelry/utils/build'
 require 'ravelry/utils/request'
@@ -27,7 +28,8 @@ require 'ravelry/user_site'
 require 'ravelry/yarn'
 require 'ravelry/yarn_weight'
 
-# Parent grouping for all classes.
+# Parent module for all classes.
+# 
 module Ravelry
   class << self
     attr_accessor :configuration

data/lib/ravelry/configuration.rb

@@ -1,11 +1,78 @@
 module Ravelry
+
+  # Adds global configuration settings to the gem, including:
+  # 
+  # * `config.access_key` - your Ravelry access key
+  # * `config.secret_key` - your Ravelry secret key
+  # * `config.personal_key` - your Ravelry personal key; primarily used for OAuth
+  # * `config.callback_url` - for OAuth, the callback url for your authentication requests
+  # 
+  # To request API keys for Ravelry, sign up for a free Ravelry account and visit this page for instructions:
+  # http://www.ravelry.com/discuss/ravelry-api/topics/1979523#1
+  # 
+  # # Required fields
+  # 
+  # The following fields are *required* to use the gem:
+  # 
+  # - Access key
+  # - Secret key
+  # - Personal key
+  # 
+  # The gem will raise a `Errors::Configuration` if you fail to provide these keys.
+  # 
+  # # Configuring your gem
+  #
+  # ```
+  # Ravelry.configure do |config|
+  #   config.access_key = ''
+  #   config.secret_key = ''
+  #   config.personal_key = ''
+  #   config.callback_url = ''
+  # end
+  # ```
+  #
+  # # Accessing configuration settings
+  # 
+  # All settings are available on the `Ravelry.configuration` object:
+  # 
+  # ```
+  # Ravelry.configuration.access_key
+  # Ravelry.configuration.secret_key
+  # Ravelry.configuration.personal_key
+  # Ravelry.configuration.callback_url
+  # ```
+  # # Resetting configuration
+  # 
+  # To reset, simply call `Ravelry.reset`.
+  # 
   class Configuration
-    attr_accessor :access_key, :secret_key, :personal_key
+    attr_writer :access_key, :secret_key, :personal_key, :callback_url
 
     def initialize
       @access_key = nil
       @secret_key = nil
       @personal_key = nil
+      @callback_url = nil
+    end
+
+    def access_key
+      raise Errors::Configuration, "Ravelry access key missing! See the documentation for configuration settings." unless @access_key
+      @access_key
+    end
+
+    def secret_key
+      raise Errors::Configuration, "Ravelry secret key missing! See the documentation for configuration settings." unless @secret_key
+      @secret_key
+    end
+
+    def personal_key
+      raise Errors::Configuration, "Ravelry personal key missing! See the documentation for configuration settings." unless @personal_key
+      @personal_key
+    end
+
+    def callback_url
+      raise Errors::Configuration, "Oauth callback url missing! See the documentation for configuration settings." unless @callback_url
+      @callback_url
     end
   end
 end

data/lib/ravelry/data.rb

@@ -1,6 +1,7 @@
 module Ravelry
 
   # Parent class that controls initialization and fetching for API objects.
+  #
   class Data
     attr_accessor :id
     attr_reader :data
@@ -9,6 +10,8 @@ module Ravelry
       @id = id
     end
 
+    # Writes the `data` instance variable and calls `build` on the child class.
+    #
     def data=(d)
       @data = d
       build
@@ -17,6 +20,7 @@ module Ravelry
 
     private
     # Determines if a GET request needs to be made.
+    #
     def get?
       @id && !@data
     end

data/lib/ravelry/errors/configuration.rb

@@ -0,0 +1,5 @@
+module Ravelry
+  module Errors
+    class Configuration < StandardError; end
+  end
+end

data/lib/ravelry/pattern.rb

@@ -22,13 +22,13 @@ 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')
@@ -98,15 +98,16 @@ module Ravelry
   # # Searching
   #
   # To search for patterns, use the `Pattern.search` class method, which
-  # returns an array of patterns:
+  # returns an array of patterns.
   #
-  # ```ruby
-  # Ravelry::Pattern.search('socks')
-  # # => [#<Pattern>, ...]
-  # ```
+  # @example
+  #   Ravelry::Pattern.search('socks')
+  #   # => [#<Pattern>, ...]
   #
   class Pattern < Data
 
+    # Whitelist and default options for fetching comments.
+    #
     COMMENT_OPTIONS = {
       sort: ['time', 'helpful', 'time_', 'helpful_'],
       page_size: 25,
@@ -119,46 +120,49 @@ 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
       @data = Utils::Request.get("patterns/#{@id}.json", :pattern)
+      self
     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')
-    # ```
-    # 
+    #
+    # @example
+    #   # Ravelry URL: http://www.ravelry.com/patterns/library/traveling-woman
+    #   pattern = Ravelry::Pattern.new
+    #   pattern.permalink_get('traveling-woman')
+    #
     def permalink_get(permalink)
       @data = Utils::Request.get("patterns/#{permalink}.json", :pattern)
+      self
     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
-    # ```
-    # 
+    #
+    # @example
+    #   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`.
-    # 
+    #
+    # See <COMMENT_OPTIONS> for valid options.
+    #
+    # @option options [String] :sort
+    # @option options [Integer] :page_size
+    # @option options [Array] :include
+    # @option options [Integer] :page
+    # @return [Array<Comment>] an array of `Comment`s
+    #
     def comments(options={})
       @comment_list ||= []
       return @comment_list if @comment_list.any?
@@ -175,6 +179,7 @@ module Ravelry
     # @option options [Integer] :page
     # @option options [Integer] :page_size
     # @return [Array<Pattern>] an array of `Pattern`s
+    #
     def self.search(query, options={})
       params = {query: query}
       params.merge!(options)
@@ -194,13 +199,15 @@ module Ravelry
     end
 
     # Returns the original raw JSON.
-    # 
+    #
     def json
       data
     end
 
     # Creates all objects associated with your pattern; returns nothing; sets `attr_readers`.
     #
+    # @return nil
+    #
     def build
       @author = Build.author(data)
       @categories = Build.categories(data)
@@ -217,59 +224,79 @@ module Ravelry
 
     # Gets comments_count from existing `data`.
     #
+    # @return Integer
+    #
     def comments_count
       data[:comments_count]
     end
 
     # Gets currency from existing `data`.
     #
+    # @return String
+    #
     def currency
       data[:currency]
     end
 
     # Gets currency_symbol from existing `data`.
     #
+    # @return String
+    #
     def currency_symbol
       data[:currency_symbol]
     end
 
     # Returns the difficult average as a Float (this is how it is stored by Ravelry).
     #
+    # @return Float
+    #
     def difficulty_average_float
       data[:difficulty_average]
     end
 
     # Returns the difficulty average rounded up or down to an Integer.
     #
+    # @return Integer
+    #
     def difficulty_average_integer
       difficulty_average_float.round(0)
     end
 
     # Gets difficulty_count (Integer) from existing `data`.
     #
+    # @return Integer
+    #
     def difficulty_count
       data[:difficulty_count]
     end
 
     # Returns true if the pattern can be downloaded.
     #
+    # @return Boolean
+    #
     def downloadable?
       data[:downloadable]
     end
 
     # Gets favorites_count (Integer) from existing `data`.
     #
+    # @return Integer
+    #
     def favorites_count
       data[:favorites_count]
     end
 
-    # Returns true if pattern is free (Boolean).
+    # Returns true if pattern is free.
+    #
+    # @return Boolean
     #
     def free?
       data[:free]
     end
 
-    # Number of stitches per inch (or 4 inches) (Float).
+    # Number of stitches per inch (or 4 inches).
+    #
+    # @return Float
     #
     def gauge
       data[:gauge]
@@ -277,11 +304,15 @@ module Ravelry
 
     # Sentence description of sts and row gauge with stitch.
     #
+    # @return String
+    #
     def gauge_description
       data[:gauge_description]
     end
 
-    # Either 1 or 4 (inches) (Integer).
+    # Either 1 or 4 (inches).
+    #
+    # @return Integer
     #
     def gauge_divisor
       data[:gauge_divisor]
@@ -289,29 +320,37 @@ module Ravelry
 
     # Pattern for gauge listed.
     #
+    # @return String
+    #
     def gauge_pattern
       data[:gauge_pattern]
     end
 
     # Gets patter name from existing `data`.
     #
+    # @return String
+    #
     def name
       data[:name]
     end
 
     # Raw pattern notes. May be mixed Markdown and HTML. Generally only useful when presenting a pattern notes editor.
     #
+    # @return String
+    #
     def notes_raw
       data[:notes]
     end
 
     # Pattern notes rendered as HTML.
     #
+    # @return String
+    #
     def notes_html
       data[:notes_html]
     end
 
-    # Returns an array of hashes with tons of information about each yarn listed in the pattern. See {#build_packs} for a complete list of helper methods.
+    # Returns an array of hashes with tons of information about each yarn listed in the pattern. See {#build} for a complete list of helper methods.
     #
     # I've included this method in case you want to have more control over how your pack information is displayed. It's likely that you'll want to use the other pack methods. While you sacrifice some fine tuning control, you also don't have to worry about dealing with a messy nested hash.
     #
@@ -319,11 +358,12 @@ module Ravelry
     #
     # If iterating through the `packs` hash, you'll likely want to do something like this:
     #
-    # `packs = pattern.packs`
-    #
-    # **`packs[0][:yarn_name]`** returns a formatted string with the brand and yarn name.
+    # @example
+    #   packs = pattern.packs
+    #   packs[0][:yarn_name]
+    #   # returns a formatted string with the brand and yarn name.
     #
-    # *Example: "Wooly Wonka Fibers Artio Sock"*
+    # @return [Array<Hash>]
     #
     def packs_raw
       data[:packs]
@@ -331,6 +371,8 @@ module Ravelry
 
     # Helper that will tell you how many yarns you have in your pack.
     #
+    # @return Integer
+    #
     def pack_count
       data[:packs].length
     end
@@ -341,6 +383,8 @@ module Ravelry
     #
     # See {Ravelry::Author} for more information about directly accessing author information.
     #
+    # @return Hash
+    #
     def pattern_author
       data[:pattern_author]
     end
@@ -351,6 +395,8 @@ module Ravelry
     #
     # See {Ravelry::Category} for more information about directly accessing category information.
     #
+    # @return [Array<Hash>]
+    #
     def pattern_categories_raw
       data[:pattern_categories]
     end
@@ -362,6 +408,8 @@ module Ravelry
     #
     # See {Ravelry::Needle} for more information about directly accessing category information.
     #
+    # @return [Array<Hash>]
+    #
     def pattern_needle_sizes_raw
       data[:pattern_needle_sizes]
     end
@@ -372,18 +420,24 @@ module Ravelry
     #
     # See {Ravelry::Needle} for more information about directly accessing category information.
     #
+    # @return [Array<Hash>]
+    #
     def pattern_type_raw
       data[:pattern_type]
     end
 
     # Gets pdf_url from existing `data`.
     #
+    # @return String
+    #
     def pdf_url
       data[:pdf_url]
     end
 
     # Gets Ravelry permalink from existing `data`.
     #
+    # @return String
+    #
     def permalink
       data[:permalink]
     end
@@ -394,11 +448,15 @@ module Ravelry
     #
     # See {Ravelry::Photo} for more information about directly accessing category information.
     #
+    # @return [Array<Hash>]
+    #
     def photos_raw
       data[:photos]
     end
 
-    # Gets price from existing `data` (Float).
+    # Gets price from existing `data`.
+    #
+    # @return Float
     #
     def price
       data[:price]
@@ -406,47 +464,63 @@ module Ravelry
 
     # Gets product_id from existing `data`.
     #
+    # @return Integer
+    #
     def product_id
       data[:product_id]
     end
 
-    # Gets projects_count from existing `data` (Integer).
+    # Gets projects_count from existing `data`.
+    #
+    # @return Integer
     #
     def projects_count
       data[:projects_count]
     end
 
-    # Gets publication date from existing `data` (Date).
+    # Gets publication date from existing `data`.
+    #
+    # @return Date
     #
     def published
       Date.parse(data[:published])
     end
 
-    # Gets number of queued projects from existing `data` (Integer).
+    # Gets number of queued projects from existing `data`.
+    #
+    # @return Integer
     #
     def queued_projects_count
       data[:queued_projects_count]
     end
 
-    # Gets rating_average from existing `data` (Float).
+    # Gets rating_average from existing `data`.
+    #
+    # @return Float
     #
     def rating_average
       data[:rating_average]
     end
 
-    # Gets number of ratings from existing `data` (Integer).
+    # Gets number of ratings from existing `data`.
+    #
+    # @return Integer
     #
     def rating_count
       data[:rating_count]
     end
 
-    # Returns true if pattern is a Ravelry download (Boolean).
+    # Returns true if pattern is a Ravelry download.
+    #
+    # @return Boolean
     #
     def ravelry_download?
       data[:ravelry_download]
     end
 
-    # Gets row gauge from existing `data` (Float).
+    # Gets row gauge from existing `data`.
+    #
+    # @return Float
     #
     def row_gauge
       data[:row_gauge]
@@ -454,17 +528,23 @@ module Ravelry
 
     # Gets sizes available from existing `data`.
     #
+    # @return String
+    #
     def sizes_available
       data[:sizes_available]
     end
 
     # Gets url from existing `data`.
     #
+    # @return String
+    #
     def url
       data[:url]
     end
 
-    # Gets yardage required from existing `data` (Integer).
+    # Gets yardage required from existing `data`.
+    #
+    # @return Integer
     #
     def yardage
       data[:yardage]
@@ -472,11 +552,15 @@ module Ravelry
 
     # Gets nice sentence yardage description with range from existing `data`.
     #
+    # @return String
+    #
     def yardage_description
       data[:yardage_description]
     end
 
-    # Gets max yards required from existing `data` (Integer).
+    # Gets max yards required from existing `data`.
+    #
+    # @return Integer
     #
     def yardage_max
       data[:yardage_max]
@@ -484,6 +568,8 @@ module Ravelry
 
     # Gets primary yarn weight description from existing `data`.
     #
+    # @return String
+    #
     def yarn_weight_description
       data[:yarn_weight_description]
     end

data/lib/ravelry/version.rb

@@ -1,3 +1,3 @@
 module Ravelry
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/spec/ravelry/configuration_spec.rb

@@ -0,0 +1,68 @@
+require_relative '../spec_helper'
+
+describe Ravelry::Configuration do
+  before do
+    @callback_url = "hello panda"
+    Ravelry.configure do |config|
+      config.access_key = ENV['RAV_ACCESS']
+      config.secret_key = ENV['RAV_SECRET']
+      config.personal_key = ENV['RAV_PERSONAL']
+      config.callback_url = @callback_url
+    end
+  end
+
+  context 'with configuration block' do
+    it 'returns the correct access_key' do
+      expect(Ravelry.configuration.access_key).to eq(ENV['RAV_ACCESS'])
+    end
+
+    it 'returns the correct secret_key' do
+      expect(Ravelry.configuration.secret_key).to eq(ENV['RAV_SECRET'])
+    end
+
+    it 'returns the correct personal_key' do
+      expect(Ravelry.configuration.personal_key).to eq(ENV['RAV_PERSONAL'])
+    end
+
+    it 'returns the correct callback_url' do
+      expect(Ravelry.configuration.callback_url).to eq(@callback_url)
+    end
+  end
+
+  context 'without configuration block' do
+    before do
+      Ravelry.reset
+    end
+
+    it 'raises a configuration error for access_key' do
+      expect { Ravelry.configuration.access_key }.to raise_error(Ravelry::Errors::Configuration)
+    end
+
+    it 'raises a configuration error for secret_key' do
+      expect { Ravelry.configuration.secret_key }.to raise_error(Ravelry::Errors::Configuration)
+    end
+
+    it 'raises a configuration error for personal_key' do
+      expect { Ravelry.configuration.personal_key }.to raise_error(Ravelry::Errors::Configuration)
+    end
+
+    it 'raises a configuration error for callback_url' do
+      expect { Ravelry.configuration.callback_url }.to raise_error(Ravelry::Errors::Configuration)
+    end
+  end
+
+  context '#reset' do
+    it 'resets configured values' do
+      expect(Ravelry.configuration.access_key).to eq(ENV['RAV_ACCESS'])
+      expect(Ravelry.configuration.secret_key).to eq(ENV['RAV_SECRET'])
+      expect(Ravelry.configuration.personal_key).to eq(ENV['RAV_PERSONAL'])
+      expect(Ravelry.configuration.callback_url).to eq(@callback_url)
+
+      Ravelry.reset
+      expect { Ravelry.configuration.access_key }.to raise_error(Ravelry::Errors::Configuration)
+      expect { Ravelry.configuration.secret_key }.to raise_error(Ravelry::Errors::Configuration)
+      expect { Ravelry.configuration.personal_key }.to raise_error(Ravelry::Errors::Configuration)
+      expect { Ravelry.configuration.callback_url }.to raise_error(Ravelry::Errors::Configuration)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ravelry
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Liz Abinante
@@ -111,6 +111,7 @@ files:
 - lib/ravelry/configuration.rb
 - lib/ravelry/craft.rb
 - lib/ravelry/data.rb
+- lib/ravelry/errors/configuration.rb
 - lib/ravelry/misc.rb
 - lib/ravelry/needle.rb
 - lib/ravelry/needles.rb
@@ -139,6 +140,7 @@ files:
 - spec/helpers/yarn_weight_helpers.rb
 - spec/ravelry/author_spec.rb
 - spec/ravelry/category_spec.rb
+- spec/ravelry/configuration_spec.rb
 - spec/ravelry/craft_spec.rb
 - spec/ravelry/data_spec.rb
 - spec/ravelry/misc_spec.rb
@@ -192,6 +194,7 @@ test_files:
 - spec/helpers/yarn_weight_helpers.rb
 - spec/ravelry/author_spec.rb
 - spec/ravelry/category_spec.rb
+- spec/ravelry/configuration_spec.rb
 - spec/ravelry/craft_spec.rb
 - spec/ravelry/data_spec.rb
 - spec/ravelry/misc_spec.rb