grammer 0.1.1.edge → 0.2.1.edge

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3efaa410d894849bb8745cb2587906913fd0b47
-  data.tar.gz: 95e81e4fa7e1a66543af2250ef52cf93c3ed213a
+  metadata.gz: 5859b926ee38745c21ad36c2cac29e3458c6ae62
+  data.tar.gz: 1c84b880ee2e0dfee69e12a464d8e759d588938b
 SHA512:
-  metadata.gz: 7aaaa0fd4b5cb468f02125cea29da80db7627714f5efeca3b924aab4b8e15338cdda57f17c2d262c47ad24a199147bb4d666d902e828058b64ce94f3ede1309f
-  data.tar.gz: e02c3fa58f25e98b2303f76d768bcba886ce4b5f776214fbed6e433c6051deed963c029fa5ad1e896f522d4ae6f2c3930444f4c6071640cdfc701c5c77940bfc
+  metadata.gz: f11bbbfe6131d6ff983cc3b1e4b125ec19fa656e137a24ceb17e69ad7892a586a26b25158c203e249bebd75d4d2cfd8a9a8f3b524c499e694da2e2d637263c6a
+  data.tar.gz: f2a7a2a063bb266788924004a9c3728f234cdd76f476ac9c8831ca28790b645e17714ea19de836db8319d2240d2e9dcb9c6b22901b41d7993b9bf289d304de39

data/lib/grammer/ig_service.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 module Grammer
+  ##
   # Handles Ig Requests
   class IgService
     include HTTParty
     base_uri 'https://www.instagram.com'
 
+    ##
+    # Requests Instagram node information with a given username.
     def node(username)
       page = self.class.get("/#{username}")
       json = Nokogiri.parse(page)

data/lib/grammer/macros.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-# Adds class macros to top level module
 module Grammer
-  def self.included(klass)
-    klass.extend(Macros)
-  end
-
+  ##
+  # = Macros
   # Defines class macros
   module Macros
+    ##
+    # Gets constant value or sets it if it haven't been defined before.
     def get_or_set_const(module_name)
       if const_defined?(module_name)
         const_get(module_name)
@@ -16,6 +15,8 @@ module Grammer
       end
     end
 
+    ##
+    # Defines methods on singleton modules in order to handle macros
     def define_module_method(mod, method_name, opts)
       mod.class_eval do
         target_attribute = opts[:on]
@@ -31,17 +32,13 @@ module Grammer
       end
     end
 
+    ##
+    # Main initializing class macro for the module.
+    # Defines a Node instance on the given name.
     def grammed_by(method_name, opts = {})
       mod = get_or_set_const(:"GammerMod#{object_id}")
       define_module_method(mod, method_name, opts)
       prepend mod
     end
-
-    def grammed_by_class_method(*methods)
-      singleton_class.class_eval do
-        include Grammer
-        grammed_by(*methods)
-      end
-    end
   end
 end

data/lib/grammer/node.rb

@@ -1,19 +1,33 @@
 # frozen_string_literal: true
 
 module Grammer
-  # Represents Instagram nodes (Users)
+  ##
+  # = Node
+  # Represents Instagram nodes (accounts)
   class Node
-    attr_reader :data, :service
+    ##
+    # General Instagram hash of data from the node
+    attr_reader :data
 
+    ##
+    # Service used for requesting instagram info
+    attr_reader :service
+
+    ##
+    # Creates a new instagram node defined by its username.
     def initialize(username, attr = {})
       @service = attr[:service] || IgService.new
       @data    = service.node(username)
     end
 
+    ##
+    # Helper for displaying node's biography
     def biography
       @data.dig('biography')
     end
 
+    ##
+    # Helper for displaying node's followers count
     def followers_count
       @data.dig('edge_followed_by', 'count')
     end

data/lib/grammer/version.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 module Grammer
+  ##
+  # = Version
   # Describes version for gemspec
   module VERSION
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 1
     BUILD = 'edge'
 

data/lib/grammer.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+##
 # Main Module
 module Grammer
   require 'httparty'
@@ -8,4 +9,10 @@ module Grammer
   require 'grammer/ig_service'
   require 'grammer/macros'
   require 'grammer/node'
+
+  ##
+  # Extends class macros to main module 
+  def self.included(klass)
+    klass.extend(Macros)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grammer
 version: !ruby/object:Gem::Version
-  version: 0.1.1.edge
+  version: 0.2.1.edge
 platform: ruby
 authors:
 - Caio Andrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -64,6 +64,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -124,8 +138,10 @@ description: Provides a simple way to connect objects to the info on a Instagram
 email: caioertai@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- README.md
 - lib/grammer.rb
 - lib/grammer/ig_service.rb
 - lib/grammer/macros.rb
@@ -136,7 +152,10 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- lib/
+- "--exclude"
+- lib/grammer/version.rb
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement