ravelry 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1b76548617aae144d81b8e817628c3175318335
-  data.tar.gz: ebcaa555d469c033819943bf99cc3b0d37bac694
+  metadata.gz: 4dcc5188a55d99529661b1bde3859b5ea1351da5
+  data.tar.gz: c526d13944150e9464254ea8d7a3a8296249d1eb
 SHA512:
-  metadata.gz: 792ab50c08765510de23fc44b2f0cf249cbdbee1a749c74528b0d1b4ec312d54d8b5c9e42852a20d2d2280ed348796983e2ca1121f7b08b3215c1d5540fb4b92
-  data.tar.gz: 2528c825060b46dcceb986985ec91f3dfcde5b8b0f374ccfe049a853eae9bef74e1a036ffa5b85cc6c6ccfff65d2f7646d0ab4917341e42ecde8b13682f1f60d
+  metadata.gz: 8ecae4dc95317877ea9f9e80d5ca9ff49adab6bd79a95da7dc634eb3b49d901348de809d5f48268c9ee64741b4dbece5f9c38cc5c045a15c33edd68d8d2b1be1
+  data.tar.gz: 1bb66e52e6f80a1512586974e4841233bca9d89226fb369d63cb37699ecf85b9ccdd1fa39662940fb8457c6a5f3416d5645c436496076ff217bfe3203ecee3c6

data/README.md

@@ -1,8 +1,10 @@
 # Ravelry
 
-_You are reading documentation for version: 0.0.2_
+_You are reading documentation for version: 0.0.4_
 
-[ ![Codeship Status for ArtCraftCode/ravelry](https://codeship.com/projects/fc6710e0-5719-0133-36cc-5ebc52a48109/status?branch=0.0.2)](https://codeship.com/projects/109462)
+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)
 
 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,7 +16,8 @@ Ravelry API documentation is currently available [here](http://www.ravelry.com/a
 
 ## API coverage
 
-* `Patterns#show` (`GET`)
+* [`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`
 
 # Installation
 
@@ -28,8 +31,8 @@ Hooray! You now have a gem.
 
 Add to your `Gemfile`:
 
-```
-gem "ravelry", "~> 0.0.2"
+```ruby
+gem "ravelry", "~> 0.0.4"
 ```
 
 **I highly recommend pinning your version** because the gem is in active development and I _promise_ I will break shit.
@@ -54,9 +57,17 @@ end
 
 Getting these keys requires a (free) Ravelry account and that you agree to the terms of use for the API.
 
+The keys are available to you throughout your application as:
+
+```ruby
+Ravelry.configuration.access_key
+Ravelry.configuration.secret_key
+Ravelry.configuration.personal_key
+```
+
 # Usage
 
-Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.0.2).
+Full documentation for this gem is available [here](http://www.rubydoc.info/gems/ravelry/0.0.4).
 
 # API quirks
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.4

data/lib/ravelry.rb

@@ -16,6 +16,9 @@ require 'ravelry/pattern_needle'
 require 'ravelry/pattern_type'
 require 'ravelry/photo'
 require 'ravelry/printing'
+require 'ravelry/social_site'
+require 'ravelry/user'
+require 'ravelry/user_site'
 require 'ravelry/yarn'
 require 'ravelry/yarn_weight'
 

data/lib/ravelry/pattern.rb

@@ -93,7 +93,7 @@ module Ravelry
     # Handles GET API call and parses JSON response.
     #
     def get
-      request = Typhoeus::Request.get("https://api.ravelry.com/patterns/#{@id}.json", userpwd: "#{ENV['RAV_ACCESS']}:#{ENV['RAV_PERSONAL']}")
+      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]
     end

data/lib/ravelry/social_site.rb

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

data/lib/ravelry/user.rb

@@ -0,0 +1,123 @@
+module Ravelry
+  # `Ravelry::User` corresponds to User objects in Ravelry and the `People#show` endpoint.
+  #
+  # This class requires your environment variables be set (see {file:README.md README}). API calls are authenticated using HTTP Basic Auth unless otherwise noted.
+  #
+  # #User objects
+  #
+  # To create an empty object:
+  #
+  # ```ruby
+  # user = Ravelry::User.new
+  # ```
+  #
+  # To complete the `GET` request, set the `id` (this is the desired user's username) and run:
+  #
+  # ```ruby
+  # user.id = "feministy"
+  # user.get
+  # ```
+  #
+  # 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
+  # user = Ravelry::User.new(id)
+  # ```
+  # 
+  # And then run your get request:
+  # 
+  # ```ruby
+  # user.get
+  # ```
+  # 
+  # Upon completing the `get` request, all of your objects and methods will ready to use!
+  #
+  # ##Loading existing user data
+  #
+  # If you have existing user data, you should initialize as follows:
+  #
+  # ```ruby
+  # user = Ravelry::User.new
+  # user.data = my_data
+  # ```
+  #
+  # You now have access to all class methods for your user. Be warned: if you run `get` again, you will override your data with fresh information from the API call.
+  #
+   # This will create the following objects and readers from the existing `data`:
+  #
+  # * `user.pattern_author` (alias: `user.author`) - a {Ravelry::Author} object
+  # * `user.user_sites` - an array of {Ravelry::UserSite} objects
+  #
+  # See the documentation for each object's available methods.
+  #
+  class User < Data
+    attr_reader :pattern_author, :user_sites
+
+    def get
+      request = Typhoeus::Request.get("https://api.ravelry.com/people/#{@id}.json", userpwd: "#{Ravelry.configuration.access_key}:#{Ravelry.configuration.personal_key}")
+      result = JSON.parse(request.response_body, {symbolize_names: true})
+      @data = result[:user]
+      @pattern_author = Build.author(@data)
+      @user_sites = Build.user_sites(@data)
+      self
+    end
+
+    def about_me
+      @data['about_me']
+    end
+
+    def about_me_html
+      @data['about_me_html']
+    end
+
+    def author
+      @pattern_author
+    end
+
+    def fave_colors
+      @data['fave_colors']
+    end
+
+    def fave_curse
+      @data['fave_curse']
+    end
+
+    def first_name
+      @data['first_name']
+    end
+
+    def large_photo_url
+      @data['large_photo_url']
+    end
+
+    def location
+      @data['location']
+    end
+
+    def photo_url
+      @data['photo_url']
+    end
+
+    def small_photo_url
+      @data['small_photo_url']
+    end
+
+    def tiny_photo_url
+      @data['tiny_photo_url']
+    end
+
+    def username
+      @data['username']
+    end
+
+    # ID from the Ravelry database.
+    # 
+    def _id
+      @data['id']
+    end
+  end
+end

data/lib/ravelry/user_site.rb

@@ -0,0 +1,22 @@
+module Ravelry
+  # There is no API access point for UserSite. The information used to create `Ravelry::UserSite` comes from other objects.
+  # 
+  # You should not create `UserSite` objects manually; they are all created–and owned by–other objects.
+  # 
+  # This does not inherit from {Ravelry::Data} because it doesn't have a corresponding API endpoint.
+  # 
+  class UserSite
+    attr_reader :id, :social_site, :url, :username
+
+    # Creates new `UserSite` from Ravelry API attributes.
+    # 
+    # All class variables are readonly.
+    # 
+    def initialize(user_site)
+      @id = user_site[:id]
+      @social_site = SocialSite.new(user_site[:social_site])
+      @url = user_site[:url]
+      @username = user_site[:username]
+    end    
+  end
+end

data/lib/ravelry/utils/build.rb

@@ -60,7 +60,7 @@ module Ravelry
       @packs
     end
 
-    # Creates and returns a of {Ravelry::PatternType} object.
+    # Creates and returns a {Ravelry::PatternType} object.
     #
     # This is not the same as a PatternCategory object.
     #
@@ -96,6 +96,18 @@ module Ravelry
       @printings
     end
 
+    # Creates and returns an array of {Ravelry::UserSite} objects.
+    #
+    # See {Ravelry::UserSite} for more information.
+    #
+    def self.user_sites(data)
+      @user_sites = []
+      data[:user_sites].each do |site|
+        @user_sites << UserSite.new(site)
+      end
+      @user_sites
+    end
+
     # Creates and returns an array of {Ravelry::Yarn} objects.
     #
     # See {Ravelry::Yarn} for more information.

data/lib/ravelry/version.rb

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

data/spec/ravelry/user_spec.rb

@@ -0,0 +1,5 @@
+require_relative '../spec_helper'
+
+describe Ravelry::User do
+  # todo!
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ravelry
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Liz Abinante
@@ -80,6 +80,9 @@ files:
 - lib/ravelry/pattern_type.rb
 - lib/ravelry/photo.rb
 - lib/ravelry/printing.rb
+- lib/ravelry/social_site.rb
+- lib/ravelry/user.rb
+- lib/ravelry/user_site.rb
 - lib/ravelry/utils/build.rb
 - lib/ravelry/utils/utilities.rb
 - lib/ravelry/version.rb
@@ -101,6 +104,7 @@ files:
 - spec/ravelry/pattern_type_spec.rb
 - spec/ravelry/photo_spec.rb
 - spec/ravelry/printing_spec.rb
+- spec/ravelry/user_spec.rb
 - spec/ravelry/utils/build_spec.rb
 - spec/ravelry/yarn_spec.rb
 - spec/ravelry/yarn_weight_spec.rb
@@ -146,6 +150,7 @@ test_files:
 - spec/ravelry/pattern_type_spec.rb
 - spec/ravelry/photo_spec.rb
 - spec/ravelry/printing_spec.rb
+- spec/ravelry/user_spec.rb
 - spec/ravelry/utils/build_spec.rb
 - spec/ravelry/yarn_spec.rb
 - spec/ravelry/yarn_weight_spec.rb